Self-Hosting
InstallationEnterprise
Starting the server for the first time and completing the installation wizard.
Installation starts the server with a few options and then completes a short wizard in the browser, which connects the database, creates the encryption keys, sets the addresses and creates the first administrator. The wizard runs once; afterwards the installation is managed from the Admin pages.
Starting the server
The server takes these options:
| Option | Description |
|---|---|
--env | The environment name, such as prod. Lowercase letters and digits, up to 16 characters. |
--stack | The stack name, such as main. Lowercase letters and digits, up to 16 characters. |
--secret-backend | aws-sm for AWS Secrets Manager, or file:/path/to/secrets.json for a file. |
--region | The AWS region, with AWS Secrets Manager. |
The environment and stack names identify the installation: secrets are named prod-main/database and so on, and the PostgreSQL database is prod_main.
The installation wizard
Until installation is complete, the server sends every request to the wizard at /install. The wizard is open to whoever reaches it first, so the server stays on a private network until the wizard is finished, with one copy running. A load balancer checks /health during installation. After a Welcome screen, the wizard has these steps:
- Secrets store: the wizard checks that the server can reach and read the secret store.
- Database: choose PostgreSQL or DynamoDB, enter the connection, and test it. The wizard saves it to the secret store.
- Encryption: the wizard creates the encryption keys and the session signing secret, and saves them to the secret store.
- Admin: enter the dashboard, API and Portal addresses, the shared cookie domain, and the first server administrator's email and a password of 8 or more characters. More administrators can be added here.
- Done: restart the server, and every copy of it, which then serve with the new settings.
After the restart, the dashboard address shows the sign-in page, and /health/ready returns 200. The first administrator signs in and continues in the Admin pages. See Configuration.
Encryption keys
The encryption keys protect the secrets Multi-Router stores in its database, such as API keys, provider keys, single sign-on and email credentials, and the session signing secret signs sign-in sessions. They live in the secret store, which is their only copy. The stored secrets are readable with these keys alone, so the secret store is backed up with the same care as the database, and kept apart from it.