Reference
This section is for the moment you already know what you want and need the exact name, type, or default. It explains as little as possible; the guides do that.
Two of the pages here are generated from the Semaphore source code, so they describe the version you are running rather than the version someone wrote a table for. For the same reason they are published in English only: a translated copy would go stale the first time an option changed, and nobody would notice.
In this section
| Page | What it covers |
|---|---|
| Configuration options | Every key of config.json with its environment variable, type, and default. Generated. |
| CLI | The semaphore command: what each command group does, how the configuration file is found, and a generated list of every command and flag. |
| API | Authenticating with a token and calling the REST endpoints. |
Related pages
The guides explain when and why to use what is listed here:
- Configuration — how options are supplied and which ones matter first.
- Admin Guide — installing, securing, and operating a server.
- User Guide — working inside a project.