Welcome. This section is for people who run Seed software for others: a site, an app environment, or the services beside them. It says what you can run, which page to read first, and what each page is for. If you only want to use Seed, you do not need any of this.
Is something broken right now? Go to troubleshooting for an app environment, to seed-deploy doctor in self-hosting for a site, or to daemon operations for a slow daemon.
What can be run
A site. A site shows one space at a web domain. It is a daemon and a web app behind a reverse proxy. This is what most operators run. Sites explains what a site is in the protocol.
An app environment. The server that runs agents and apps. It can run beside a site, alone, or inside the desktop app. See the app environment program map.
The vault. The service that keeps the keys of people's accounts and signs them in. A site uses the hosted vault, unless it is an enterprise node. See the vault program map.
Notify. The service that keeps notification inboxes and sends email. A site uses the hosted one, unless it is an enterprise node. See the notify program map.
The software section has one map page for each program. It says where the code is, what the program listens on, and how you configure it.
Reading order
Self-hosting, to set up a site and learn the seed-deploy command.
Publishing a space to a domain and custom domains, to give it an address.
Operations, if the site runs an app environment or you run one alone. It leads to every app environment page.
Troubleshooting, when something is wrong.
If you are setting up a closed node for one organization, read the enterprise node page in place of step 2.
Sites
Self-hosting: install a site with the deploy script, register a space, update and back up the node.
Enterprise node: the deploy script's second setup, for invited people only and cut off from the public network.
Running an invite-only vault: invitations and the admin API of the vault on an enterprise node.
Publishing a space to a domain: the owner's steps for giving a space a web address.
Custom domains: the DNS side of serving a site at your own domain, and moving a node to a new hostname.
Daemon operations: a daemon that is slow or uses too much memory.
Daemon network reference: ports, flags, relays and debug pages of the daemon's network layer.
App environment
Operations: the overview, and the way to every page below.
Environments: the five setups and the settings each one uses.
Self-hosting an app environment: running the image on your own server.
Configuration: every environment variable and flag.
Deploying: the image, its version metadata, the CI workflows, and rollouts.
Endpoints and health: every path, and the health, version, timing and metrics endpoints.
Web research backends: the helper containers behind web search and web reads through a browser.
Code execution backend: what the host needs for sandboxes, and how to check them.
Run queue: how many runs execute at once, restarts, retries, and when the queue pauses.
Startup and shutdown: the start order, the background tasks, the stop order.
Logs: log levels and the list of log lines.
Persistence: the database schema, table by table.
Database retention: what keeps the database from growing forever, and how to shrink it.
Troubleshooting: starts from what you see.
Debugging runs: runs that are stuck, lost or failing.
Diagnosing a stalled server: a server that is up but does not answer.
See also
Software, what each program is
Agents, how the things an app environment runs work
Build, the APIs these servers answer
Contribute, working on the code, including testing the app environment
Sites and nodes
Running an app environment
When something is wrong
Do you like what you are reading? Subscribe to receive updates.
Unsubscribe anytime