Configuration

There are 3 ways to configure Semaphore:
​Snap configuration​
​Interactive setup​
​Configuration file​
Snap configuration
Snap configuration should be used for configuration Semaphore installed via Snap.
List of available option you can see by following command:
1
sudo snap get semaphore
Copied!
You can change each of this option. For example if you want to change Semaphore port, use following command:
1
sudo snap set semaphore port=4444
Copied!
Don't forget to restart Semaphore after that:
1
sudo snap restart semaphore
Copied!
Interactive setup
Use this option for first time configuration (not working for Semaphore installed via Snap).
1
semaphore setup
Copied!
Configuration file
Semaphore uses config.json configuration file with following content:
1
{
2
  "bolt": {
3
    "host": "/home/ubuntu/semaphore.bolt",
4
  },
5
  "mysql": {
6
    "host": "localhost",
7
    "user": "root",
8
    "pass": "*****",
9
    "name": "semaphore",
10
    "options": {}
11
  },
12
  "postgres": {
13
    "host": "localhost",
14
    "user": "postgres",
15
    "pass": "*****",
16
    "name": "semaphore",
17
    "options": {}
18
  },
19
  "dialect": "postgres",
20
  "port": "",
21
  "interface": "",
22
  "tmp_path": "/tmp/semaphore",
23
  "cookie_hash": "*****",
24
  "cookie_encryption": "*****",
25
  "access_key_encryption": "*****",
26
  "email_sender": "",
27
  "email_host": "",
28
  "email_port": "",
29
  "web_host": "",
30
  "ldap_binddn": "",
31
  "ldap_bindpassword": "",
32
  "ldap_server": "",
33
  "ldap_searchdn": "",
34
  "ldap_searchfilter": "",
35
  "ldap_mappings": {
36
    "dn": "",
37
    "mail": "",
38
    "uid": "",
39
    "cn": ""
40
  },
41
  "telegram_chat": "",
42
  "telegram_token": "",
43
  "concurrency_mode": "",
44
  "max_parallel_tasks": 0,
45
  "email_alert": false,
46
  "telegram_alert": false,
47
  "ldap_enable": false,
48
  "ldap_needtls": false
49
}
Copied!
Configuration options
Configuration file
Snap configuration
Description
bolt.host
—
Path to the BoltDB database file
mysql.host
mysql.host
MySQL database host
mysql.name
mysql.name
MySQL database (schama) name
mysql.user
mysql.user
MySQL user
mysql.pass
mysql.pass
MySQL user's password
postgres.host
postgres.host
Postgres database host
postgres.name
postgres.name
Postgres database (schama) name
postgres.user
postgres.user
Postgres user
postgres.pass
postgres.pass
Postgres user's password
dialect
dialect
Can be mysql, postgres or bolt
port
port
TCP port on which the web interface will be available. Defalt: 3000
interface
interface
Useful if your server has multiple network interfaces
tmp_path
—
Path to directory where cloned repositories and generated files are stored. Deafult: /tmp/semaphore
access_key_encryption
access-key-encryption
Secret key used for encypting access keys in datatabase. Read more in Database encryption reference.
email_sender
email-sender
​
email_host
email-host
​
email_port
email-port
​
web_host
web-host
Can be useful if you want to use Semaphore by the subpath, for example: http://yourdomain.com/semaphore.
ldap_binddn
ldap-binddn
​
ldap_bindpassword
ldap-bindpassword
​

Administration Guide - Previous

Installation

Next - Administration Guide

Upgrading

Last modified 3mo ago

Copy link

Contents

Snap configuration

Interactive setup

Configuration file

Configuration options