Skip to content

[console]

The web console listener, its TLS, the owner token file, restarts and updates from the console.

Key Type Default Description
console.enabled bool true enabled starts the console listener. Absent, it follows [personal] enabled, so the default is true; enabled = true with [personal] enabled = false fails config load.
console.bind string "127.0.0.1:18081" bind is the console listener address (default 127.0.0.1:18081). A bind other than loopback needs tls_cert and tls_key, or allow_plaintext = true.
console.tls_cert string tls_cert and tls_key are PEM file paths for HTTPS on the console listener; set both or neither.
console.tls_key string tls_cert and tls_key are PEM file paths for HTTPS on the console listener; set both or neither.
console.allow_plaintext bool false allow_plaintext permits plain HTTP on a non-loopback console bind. Use it only on a transport you trust, such as WireGuard; an address range alone does not prove encryption.
console.admin_token_file string admin_token_file holds the console/admin token. Empty selects <storage.dir>/console-token, which Prism creates with mode 0600 on first start when PRISM_ADMIN_TOKEN is unset.
console.update_check_url string update_check_url is the release API the console reads and installs from: a ../releases/latest endpoint of Forgejo/Gitea, GitHub or GitCode. Empty (the default) disables online checks and installs; an offline package can still be installed. Only https, or http on loopback, private and overlay addresses.
console.update_check_token_env string update_check_token_env names the environment variable holding a read credential for update_check_url, for a release source that is not public. The secret never sits in this file, and it is sent only to that origin, never through a mirror.
console.update_mirrors array of string update_mirrors are download prefixes the console may use instead of the release source itself: the original URL is appended to the prefix (gh-proxy style). A mirror cannot forge a package, because every archive is checked against the signed SHA256SUMS.
console.allow_update bool false allow_update lets the console download, verify and install a signed release, then hand the process over to it. Default false. It needs allow_restart as well: the new version starts through the same drain.
console.update_channel string update_channel is the release channel “latest” resolves in: “stable” (the default, /releases/latest) or “prerelease”, where the newest non-draft release, pre-releases included, is the latest.
console.allow_restart bool allow_restart lets the console restart and stop Prism. Restart exits with code 75 after draining, stop with code 0; the supervisor must restart on 75 and not on 0 (the reference unit sets RestartForceExitStatus=75 and RestartPreventExitStatus=0). Unset (the default), Prism asks its supervisor – systemd or launchd – and offers restart and stop only when that policy brings it back on 75 and keeps it down on 0. false turns both off; true asserts the supervisor does so without asking.
console.public_url string public_url is the origin people open the console at, such as https://prism.example.net:18081. Passkeys are bound to its host name. Empty derives it from bind: localhost for a loopback bind, the bind’s host name for a TLS bind.