multi-router.aidocs

Self-Hosting

ConfigurationEnterprise

The Admin pages that configure a self-hosted installation.

A self-hosted installation is configured from the Admin pages, opened from Admin in the profile menu by server administrators. Settings are stored in the database, with their secrets encrypted, so every copy of the server shares them. A strip across the top of every Admin page shows the mode, environment, stack, build, database and catalog, with the installation's addresses.

Admin pages

Each Admin page covers one part of the installation:

PageSets
OverviewA read-only summary of the installation.
UsersUsers: activating, deactivating, deleting, and Promote to server admin.
DatabaseA view of the database tables.
VaultEach secret the server reads at startup, with its status. Values stay hidden.
TrafficThe ClickHouse connection, the Storage Policy, and payload storage.
WebhooksWebhook delivery for the whole installation, with its switch.
BudgetsBudgets on or off, with reconciliation reports.
EmailThe SMTP server, branding and templates, with a test send.
FeaturesGitHub integration for prompts, with the GitHub App credentials.
CatalogCatalog fetching, its source address, and approving new catalog versions.
AuthenticationGoogle and GitHub sign-in credentials, Enterprise SSO, and the session cookie domain.

Traffic

The Traffic page connects ClickHouse, which stores request records. It accepts ClickHouse Cloud or a self-hosted ClickHouse over HTTPS or the native protocol, with or without TLS. The same page sets the Storage Policy, which caps what every router records, and payload storage in Amazon S3 or a local directory. Saving the connection creates the ClickHouse database, named like the PostgreSQL one. See Request Logging.

Email

The Email page sets the SMTP server, with its SMTP host, Port, Encryption (STARTTLS or TLS), Username, Password, From address, From name and Reply-to, and the branding of Multi-Router's emails, including the company name and address for the footer. Email delivery is turned on with its switch once the SMTP settings are saved, and a test send checks them. Invitations, Portal links and budget alerts then go out through it.

Feature switches

Feature switches turn parts of Multi-Router on for the installation, each on its own Admin page:

SwitchPageDefaultTurns on
Enterprise SSOAuthenticationOffSingle sign-on and user provisioning.
GitHub integration for promptsFeaturesOnGitHub prompts, with the GitHub App credentials.
Webhook deliveryWebhooksOnBudget alerts to webhook endpoints.
Catalog fetchingCatalogOffModel catalog updates.
BudgetsBudgetsOnMetering, budgets and budget rules. Read when the server starts, so a change applies after a restart, shown as restart pending.

Authentication

The Authentication page sets how people sign in: Google and GitHub sign-in with their client credentials, Enterprise SSO, and the session cookie domain shared by the dashboard, API and Portal addresses. Changing the cookie domain signs everyone out, and asks to type INVALIDATE ALL SESSIONS to confirm. See Single Sign-On.

Addresses

The dashboard, API and Portal addresses set in the wizard decide which surface each request reaches: the API address serves the API, the Portal address serves the Portal, and other addresses serve the dashboard. The address row in the strip at the top of the Admin pages changes the Deployment base URL, Portal URL and API URL, and every copy of the server picks up a change within 30 seconds.

InstallationOperations
Was this helpful?