Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install a new server

The repository has deployment examples for a Linux binary and an OCI image. Release publication and signing are still being set up. The commands below require a release with the named artifacts and verification instructions. See release preparation for status. For local evaluation from source, use the development guide.

PathHostDeployment setup
Debian binaryA new or existing Linux serverLinux binary, systemd unit, host configuration, and Caddy
OCI imageExisting container infrastructureImage running as UID 10001, with configuration and storage requirements

Container examples cover Docker Compose, Incus, and Proxmox VE.

Requirements

You need a stable public domain, DNS control, ports 80 and 443, PostgreSQL, space for media and independent backups, and an SMTP relay if the server will send registration or password-reset mail. Webxdc also needs DNS for both webxdc.<social-domain> and *.webxdc.<social-domain>.

Choose domain and optional account_domain permanently before federation begins. If handles should use an apex domain while Plamenu runs on a subdomain, read Split-domain handles before installing.

After either installation path, create the first administrator, reboot once, rehearse a restore, and configure external checks for /ready and disk space before inviting members.