Configuration reference
This page lists every configuration key and environment variable that affects the
MCP server. Keys are written to the Neptune DXP - Open Edition configuration file
(typically planet9.json) unless noted otherwise. Environment variables take
precedence over file values at runtime.
For instructions on how to apply configuration changes so they persist through the database layer, see Applying configuration changes.
Configuration keys
| Key | Environment variable | Type | Default | Description |
|---|---|---|---|---|
|
|
String |
(empty) |
The public URL at which clients reach the MCP server. Required when the server
runs behind a reverse proxy. Supply scheme and host only, without a trailing slash,
for example, Can also be set from the Cockpit under System Settings → AI → MCP → Public
URL; this is equivalent to setting the key directly. The scheme must match how
the server actually runs ( |
|
— |
Boolean |
|
Enables the built-in HTTPS listener. Must be |
|
— |
Integer |
|
The port on which the HTTPS listener binds when |
|
— |
String |
(empty) |
Absolute path to the PEM-encoded private key file used for TLS. Required when
|
|
— |
String |
(empty) |
Absolute path to the PEM-encoded certificate file used for TLS. Required when
|
Environment variables (runtime only)
The following variables are set in the process environment and are not written to the configuration file. They are evaluated at server startup.
| Variable | Values | Description |
|---|---|---|
|
|
When set to |
|
|
Disables the startup check that prevents OAuth metadata from advertising a plain HTTP issuer URL. Use only on non-localhost development hosts. Never set in production. See Local development. |
|
|
Startup flags
The following flags are passed to the planet9 binary (or the equivalent npm
script) at startup. They are not persistent configuration values.
| Flag | Description |
|---|---|
|
Initializes the database schema, seeds the default admin user, and exits.
Required once on a fresh install before the server can authenticate anyone or
serve the |
|
Related topics
-
Deployment — how to apply these configuration values in HTTPS and reverse proxy scenarios.
-
Troubleshooting — diagnosing problems that arise from misconfigured keys.
-
Neptune DXP - Open Edition environment variables — full reference for all platform configuration keys.