Environment Variables

DOMAIN

Type: string
Default: localhost
Required: No

The public facing domain name of this instance. Will also read the X-Forwarded-Host header if served behind a reverse proxy.

SERVER_TITLE

Type: string
Default: {Server Title}
Required: No

The display title for the server. Used in both the global header and each page’s <title>.

MIRROR_{N}

Type: string
Example: valgrind,https://sourceware.org/git/valgrind.git,Valgrind is an instrumentation framework for building dynamic analysis tools.
Required: No

A list, starting from 1, of repositories to mirror on this instance. Pulled for updates hourly.

MIRRORS_FETCH_ON_STARTUP

Type: boolean
Default: false
Required: No

Set this to true to force a git fetch on all mirrors during start. Mirrors will still periodically pull for updates in the background if this is left false.

OAUTH2_CLIENT

Type: string
Example: provider|client_id|client_secret
Required: No

In order to create non-mirror repositories and other resources which require an account, Shale must be connected to an OAuth 2 Identity Provider. If the provider code portion of this variable is ever changed, accounts created on the previous provider would be unable to be logged into. Learn more about Shale’s OAuth 2 capabilities here.

SESSION_SECRET

Type: string
Default: Random
Required: No

64 hex digits used to seed cryptographic signing of session cookies. Set this to allow sessions to persist between server restarts. Switching to different cookie strategy in future versions.

NPROC

Type: integer
Default: System thread count
Required: No

To handle incoming HTTP requests Shale will start a thread pool. Use this to limit its size.

OTEL_EXPORTER_OTLP_TRACES_ENDPOINT

Type: URL
Default: http://localhost:4318/v1/traces
Required: No

An OpenTelemetry endpoint for collecting Traces. Learn more about Shale’s tracing capabilities here.

ANALYTICS

Type: Union
Default: none
Required: No

Learn more about Shale’s frontend analytics capabilities here.