Configuration

All configuration lives in a single goop.json file in your peer directory. There are no environment variables or CLI flags for settings.

Full reference

{
  "identity": {
    "key_file": "data/identity.key"
  },
  "paths": {
    "site_root": "site",
    "site_source": "site/src",
    "site_stage": "site/stage"
  },
  "p2p": {
    "listen_port": 0,
    "mdns_tag": "goop-mdns"
  },
  "presence": {
    "topic": "goop.presence.v1",
    "ttl_seconds": 20,
    "heartbeat_seconds": 5,
    "rendezvous_host": false,
    "rendezvous_port": 8787,
    "rendezvous_wan": "",
    "rendezvous_only": false,
    "admin_password": "",
    "templates_dir": "templates",
    "peer_db_path": ""
  },
  "profile": {
    "label": "hello",
    "email": ""
  },
  "viewer": {
    "http_addr": "127.0.0.1:8080",
    "debug": false,
    "theme": "dark"
  },
  "lua": {
    "enabled": false,
    "script_dir": "site/lua",
    "timeout_seconds": 5,
    "max_memory_mb": 10,
    "rate_limit_per_peer": 30,
    "rate_limit_global": 120,
    "http_enabled": true,
    "kv_enabled": true
  }
}

Section details

identity

Field	Default	Description
`key_file`	`data/identity.key`	Path to the peer's persistent cryptographic identity. Created automatically on first run.

paths

Field	Default	Description
`site_root`	`site`	Directory served to visitors.
`site_source`	`site/src`	Source directory for the site editor (optional).
`site_stage`	`site/stage`	Staging directory for previewing changes (optional). Must differ from `site_source`.

p2p

Field	Default	Description
`listen_port`	`0`	libp2p listen port. `0` picks an available port automatically. Set a fixed port if you need to configure firewall rules.
`mdns_tag`	`goop-mdns`	mDNS service tag. Peers with the same tag discover each other on the local network.

presence

Field	Default	Description
`topic`	`goop.presence.v1`	PubSub topic for presence messages.
`ttl_seconds`	`20`	Seconds before an unresponsive peer is considered offline.
`heartbeat_seconds`	`5`	Seconds between presence announcements. Must be less than `ttl_seconds`.
`rendezvous_host`	`false`	Enable the built-in rendezvous server.
`rendezvous_port`	`8787`	Port for the rendezvous server (when hosting).
`rendezvous_wan`	`""`	URL of a remote rendezvous server to publish presence to.
`rendezvous_only`	`false`	Run only the rendezvous server with no P2P node.
`admin_password`	`""`	Password for the rendezvous admin panel. Leave empty to disable admin.
`templates_dir`	`templates`	Directory containing template store templates.
`peer_db_path`	`""`	SQLite path for persisting peer state across restarts (useful for multi-instance rendezvous).

profile

Field	Default	Description
`label`	`hello`	Display name shown to other peers.
`email`	`""`	Email address for identity and avatar.

viewer

Field	Default	Description
`http_addr`	`127.0.0.1:8080`	Bind address for the local viewer. Use `127.0.0.1` to restrict access to your machine.
`debug`	`false`	Enable debug mode in the viewer.
`theme`	`dark`	Default theme: `dark` or `light`.

lua

Field	Default	Description
`enabled`	`false`	Enable Lua scripting.
`script_dir`	`site/lua`	Directory containing Lua scripts.
`timeout_seconds`	`5`	Maximum execution time per script invocation (1--60).
`max_memory_mb`	`10`	Maximum memory per Lua VM.
`rate_limit_per_peer`	`30`	Maximum Lua calls per minute per remote peer.
`rate_limit_global`	`120`	Maximum total Lua calls per minute.
`http_enabled`	`true`	Allow Lua scripts to make HTTP requests.
`kv_enabled`	`true`	Allow Lua scripts to use the key-value store.

Validation rules

site_source and site_stage must be different paths.
heartbeat_seconds must be less than ttl_seconds.
listen_port must be 0 or between 1 and 65535.

Example configurations

Simple peer

{
  "profile": { "label": "My Site" },
  "viewer": { "http_addr": "127.0.0.1:8080" }
}

Peer with WAN rendezvous

{
  "profile": { "label": "My Site" },
  "presence": {
    "rendezvous_wan": "https://rendezvous.example.com"
  },
  "p2p": { "listen_port": 4001 }
}

Dedicated rendezvous server

{
  "presence": {
    "rendezvous_only": true,
    "rendezvous_host": true,
    "rendezvous_port": 8787,
    "admin_password": "secure-password"
  }
}