Site

Static Site Configuration

Configuration for serving the static website (documentation and UI) from the embedded HTTP server.

Routes: / Landing page /docs/** Documentation /ui/** Operator UI /ref/* Redirect to documentation anchors

Documentation at /docs + /ref redirects The documentation includes configuration reference, guides, and API docs. The /ref/* routes provide canonical deep-links that redirect to documentation anchors (e.g., /ref/c/database.url → /docs/reference/config/database#database.url).

Enable documentation serving at /docs and /ref redirects

Priority: SCRIBE_SITE_DOCS_ENABLED > config

site.docs.enabled = true
site.docs.enabled = ${?SCRIBE_SITE_DOCS_ENABLED}

Enable the static site serving (/, /docs, /ui, /ref)

Priority: SCRIBE_SITE_ENABLED > config

site.enabled = true
site.enabled = ${?SCRIBE_SITE_ENABLED}

HTTP server settings for site routes.

This section inherits all settings from http. Override individual settings as needed.

Socket reference for site routes. Use a named socket from http.sockets.* or omit for @default. If unset (no env var, key omitted, or value is null), defaults to @default.

Priority: SCRIBE_SITE_SOCKET > config

site.socket = ${?SCRIBE_SITE_SOCKET}

Operator UI

The operator UI provides a web interface for monitoring and managing the IdentityScribe instance. Requires /api and /observe on the same socket.

Enable the operator UI at /ui

Priority: SCRIBE_SITE_UI_ENABLED > config

site.ui.enabled = true
site.ui.enabled = ${?SCRIBE_SITE_UI_ENABLED}