Skip to main content

Configuration

Semaphore reads its settings from a configuration file and environment variables. The online configurator helps you prepare either format by filling in a form. Choose the workflow that fits how you run your server.

In this section​

MethodUse it when
Online configuratorYou want a form that generates configuration and startup commands for a binary or Docker installation.
Configuration fileYou want to keep server settings in a config.json file.
Environment variablesYou manage settings through Docker, a service definition, or your deployment tools.

Configuration options​

An environment variable overrides the corresponding value in the configuration file. The built-in default applies when neither is set. If editing the file has no effect, check the environment passed to the Semaphore process.

The Configuration options reference lists option names, environment variables, types, and defaults. It is generated from the Semaphore source; use documentation for your release when configuring an older server.

Public URL​

Set web_host (or SEMAPHORE_WEB_ROOT) to the address users open in their browser. For example, if a reverse proxy serves Semaphore at https://example.com/semaphore, use that full address, including /semaphore. This is the public address, not the internal address the proxy connects to.

Where to start​

For a new server, open the online configurator guide above and follow the binary or Docker steps. For an existing server, update the file or environment variables used by its service, then restart Semaphore to apply the changes.