Documentation Last reviewed 2026-11-14

Install and requirements

What a node needs, what the install does, and which ports are involved.

What a node needs and what the install does. The step-by-step guide is in the repository: install from a release.

The machine

Minimum2 GB memory, 10 GB free disk. The preflight check refuses to install below this
Recommended8 GB memory, 20 GB disk, 2 cores
Operating systemDebian or Ubuntu. A local LXC container or an existing machine

What the install does

One command, unattended, in a fixed order. Allow 30 to 45 minutes; most of it is pulling packages.

  1. Preflight: check the machine and install system dependencies.
  2. Base: database cluster, reverse proxy, authentication, core services.
  3. Components, each from the source vendored in the release: registry, documents, memory, planner, panel, gateway, dispatcher, runner, communication and the rest.
  4. Validation: more than 200 checks. The install is not done until they pass.

Afterwards the owner gets a one-time link to set their own credentials.

Network

No channel needs a port opened toward the machine. Mail is polled over IMAP and sent over SMTP, and Telegram is long-polled.

A node can sit entirely inside your network with nothing published, and mail and Telegram keep working. Publish 443 and you also get Studio from outside and a chat widget for your website. The WireGuard port is optional (--no-vpn).

The firewall denies incoming by default. The database, gateway, registry API, panel backend, memory and document services sit behind it.

What leaves the machine

The model call, and whatever the channels you turned on must reach to send: the model provider, your mail server, any chat platform you connected. If you connect Google, you approve its scope in your own Google account.

Records, configuration, message history and the audit log stay on the machine.

Updates and backups

Updates, backup and restore are documented procedures in the repository.

Reviewed 2026-11-14. Older than 90 days counts as broken. Something here wrong? Tell me