Goop² Documentation

User guide & reference

Home

Getting Started

Desktop app (recommended)

The easiest way to use Goop2 is the desktop application, available as a native build or as a Flatpak.

Option A: Build from source

You need Go 1.24+ and the Wails CLI:

git clone https://github.com/petervdpas/goop2.git
cd goop2
wails build

Option B: Flatpak

Install the Flatpak package from the latest release:

flatpak install goop2.flatpak
flatpak run com.github.petervdpas.goop2

Launch

./build/bin/goop2

The app opens a window where you can create peers, start and stop them, and manage your sites.

Create a peer

Click Create Peer, give it a name, and hit create. Goop2 sets up the directory, generates a cryptographic identity, and creates a default site -- all automatically.

Start and visit

Click Start on your peer. The viewer opens in your browser, showing your site and any other peers on your local network.

From there you can edit your site, pick a template, or connect to a rendezvous server to find peers across the internet.

CLI mode

If you're running on a server or prefer the terminal, you can run a peer without the desktop UI:

go build -o goop2
./goop2 peer ./peers/mysite

If the directory doesn't have a goop.json yet, one is created automatically with sensible defaults. You can edit it afterward to change your display name, connect to a rendezvous server, enable Lua scripting, etc.

See Configuration for the full reference.

Rendezvous server

To run a standalone rendezvous server for peer discovery across networks:

./goop2 rendezvous ./peers/server

This starts a lightweight HTTP server that peers can publish their presence to. See Connecting to Peers for setup details.

What's next?