Operator guide

Production install, multi-operator ACL, feature flags, logging, compose, and backup.

Recommended: one-line installer

On a Linux host with Docker already installed:

curl -fsSL https://install.peardock.boats | bash -s -- --server --yes

This installs the Bare server binary, creates user peardock, adds it to the docker group, writes a systemd unit, and can enable the service immediately.

sudo systemctl status peardock
sudo journalctl -u peardock -f
# copy public key from logs into the desktop client

Full flags and client install: Download & install.

Paths (installer defaults)

Path	Role
`/opt/peardock/peardock-server`	Server binary
`/opt/peardock/.env`	Identity / env (mode 600)
`/etc/systemd/system/peardock.service`	systemd unit
`journalctl -u peardock`	Logs

systemd unit (current)

Matches deploy/peardock.service and the unit written by install.sh:

[Unit]
Description=peardock HyperDHT Docker control plane
Documentation=https://git.ssh.surf/snxraven/peardock
After=network-online.target
Wants=network-online.target
Wants=docker.service

[Service]
Type=simple
WorkingDirectory=/opt/peardock
ExecStart=/opt/peardock/peardock-server
Restart=on-failure
RestartSec=5
TimeoutStartSec=30
TimeoutStopSec=30
NoNewPrivileges=true
PrivateTmp=true
User=peardock
Group=docker
SupplementaryGroups=docker
Environment=NODE_ENV=production
EnvironmentFile=-/opt/peardock/.env
ReadWritePaths=/opt/peardock

[Install]
WantedBy=multi-user.target

Source install alternative for ExecStart:

ExecStart=/usr/bin/node /opt/peardock/server/server.js

Docker group / socket access

Engine sockets are typically root:docker mode 660. The service must run as a user in group docker (or the socket’s group).

# Installer does this; manual recovery:
sudo usermod -aG docker peardock
# if docker group was just created, restart Docker once
sudo systemctl restart docker
sudo systemctl restart peardock

Symptoms of a missing group: empty container lists, start failures, “permission denied” on the socket.

Manual install from source

git clone https://git.ssh.surf/snxraven/peardock.git /opt/peardock
cd /opt/peardock
npm ci --omit=dev   # Node.js ≥ 20

sudo useradd --system --home /opt/peardock --shell /usr/sbin/nologin peardock
sudo usermod -aG docker peardock
sudo cp deploy/peardock.service /etc/systemd/system/
# edit ExecStart if using node instead of Bare binary
sudo systemctl daemon-reload
sudo systemctl enable --now peardock
sudo journalctl -u peardock -f

Healthcheck

node scripts/healthcheck.js
# exit 0 if Docker socket answers

Multi-operator setup

On first connect, note the client’s peer id (handshake returns peerId).
Configure /opt/peardock/.env (or Environment= in the unit):

PEARDOCK_DEFAULT_ROLE=viewer
PEARDOCK_ADMIN_KEYS=<64-hex-client-public-key>
PEARDOCK_PEER_ALLOWLIST=1
PEARDOCK_BROWSE_ROOTS=/var/lib/docker/volumes
PEARDOCK_AUDIT=1

As admin: Access → Create invite → send token to operator.
Operator connects with server public key + invite token as supported.
Revoke lost devices from Access.

Registry vault

Credentials encrypted at rest (AES-GCM derived from SERVER_SEED):

UI: Access → Registry vault
RPC: vaultStoreCredential, vaultUseCredential, listVaultCredentials
File: peardock-vault.json (mode 600). Override with PEARDOCK_VAULT_PATH.

Feature flags

Env	Effect
`ENABLE_SWARM=0`	Disable Swarm / services / secrets / configs RPC (on by default)
`ENABLE_PLUGINS=1`	Plugin install/enable/remove
`ENABLE_HOLESAIL=0`	Disable Holesail tunnels (on by default)
`PEARDOCK_MAX_TUNNELS`	Max concurrent tunnels (default 20)
`PEARDOCK_TUNNEL_HOSTS`	Extra allowed tunnel target hosts
`PEARDOCK_UNRESTRICTED_CLI=1`	Broader docker CLI for admin
`PEARDOCK_BROWSE_OPEN=1`	Legacy open host FS browse (discouraged)

Logging

Env	Effect
`LOG_LEVEL`	error · warn · info · debug
`LOG_FORMAT`	pretty (TTY) · json (journald)
`ENABLE_FILE_LOGGING=1`	JSON lines under LOG_DIR
`NO_COLOR=1`	Disable ANSI in pretty mode

# Prefer journald JSON in production
# Environment=LOG_FORMAT=json
# Environment=LOG_LEVEL=info
sudo journalctl -u peardock -f

Compose stacks

deployStack accepts:

composeContent (required)
overrideContent: second compose file
envFileContent: written as .env for compose CLI
profiles: array or comma string
build: true: runs docker compose up --build

Metrics

RPC getMetrics returns process memory, RPC counters, latency percentiles, feature flags.

Updating the server

Re-run the installer with --server --yes, or replace /opt/peardock/peardock-server from a newer rolling tarball.
Keep /opt/peardock/.env (seed) and vault/peer files.
sudo systemctl restart peardock

Certification / soak

npm run soak          # short Docker health loop
npm run soak:24h      # 24h certification

Backup

Back up atomically from the server data dir (default /opt/peardock):

.env (SERVER_SEED)
peardock-vault.json
peardock-peers.json
peardock-audit.log (optional)