Components configuration

When starting an agola instance it will read its config from the configuration file

WARNING

Since agola is composed of many components that can be distributed you should keep the configuration file in sync between all components

Agola configuration file reference

This is a full commented example (with all the available options):

  1. gateway:
  2.   # The gateway api exposed url to client
  3.   apiExposedURL: "https://youragola.com"
  4.   # The web interface exposed url to client, usually the same as the api
  5.   # exposed url but you can separate the api url from the web url
  6.   webExposedURL: "https://youragola.com"
  7.   # The run service url (use a load balancer when having multiple run services)
  8.   runserviceURL: "http://runservice:4000"
  9.   # The config store url (use a load balancer when having multiple run services)
  10.   configstoreURL: "http://configstore:4002"
  11.   # The agola internal git server url (currently only a single instance is supported)
  12.   gitserverURL: "http://gitserver:4003"
  14.   # web server config
  15.   web:
  16.     listenAddress: ":8000"
  17.     # use TLS (https)
  18.     tls: true
  19.     # TLSCert is the path to the pem formatted server certificate. If the
  20.     # certificate is signed by a certificate authority, the certFile should be
  21.     # the concatenation of the server's certificate, any intermediates, and the
  22.     # CA's certificate.
  23.     #
  24.     tlsCertFile: "/path/to/certfile"
  26.     # Server cert private key
  27.     #
  28.     tlsKeyFile: "/path/to/certkeyfile"
  30.     # CORS allowed origins
  31.     # Enable if the web ui is on a different host:port than the gateway api
  32.     #allowedOrigins: "*"
  34.   # token signing configuration
  35.   tokenSigning:
  36.     # token duration (defaults to 12 hours)
  37.     #duration: 12h
  39.     # hmac or rsa (if possible use rsa)
  40.     method: hmac
  41.     # key to use when signing with hmac
  42.     key: supersecretsigningkey
  44.     # paths to the private and public keys in pem encoding when using rsa signing
  45.     #privateKeyPath: /path/to/privatekey.pem
  46.     #publicKeyPath: /path/to/public.pem
  48.   # admin token, token to use to do super user agola administration
  49.   adminToken: "changeme"
  51. scheduler:
  52.   runserviceURL: "http://runservice:4000"
  54. notification:
  55.   webExposedURL: "https://youragola.com"
  56.   runserviceURL: "http://runservice:4000"
  57.   configstoreURL: "http://configstore:4002"
  59.   # etcd client configuration
  60.   etcd:
  61.     endpoints: "http://youretcd:2379"
  62.     # etc client tls config
  63.     #tlsCertFile
  64.     #tlsKeyFile
  65.     #tlsCAFile
  66.     #tlsSkipVerify
  68. configstore:
  69.   dataDir: /data/agola/configstore
  71.   etcd:
  72.     endpoints: "http://localhost:2379"
  74.   objectStorage:
  75.     # posix based object storage. It requires a shared posix fs like nfs, chepfs etc...
  76.     #
  77.     #type: posix
  78.     #path: /data/agola/configstore/ost
  80.     # s3 based object storage
  81.     type: s3
  82.     # example with minio
  83.     endpoint: "http://yourminio:9000"
  84.     bucket: configstore
  85.     accessKey: minio
  86.     secretAccessKey: minio123
  88.   web:
  89.     listenAddress: ":4002"
  91. runservice:
  92.   #debug: true
  93.   dataDir: /data/agola/runservice
  94.   etcd:
  95.     endpoints: "http://localhost:2379"
  96.   objectStorage:
  97.     # posix based object storage. It requires a shared posix fs like nfs, chepfs etc...
  98.     #
  99.     #type: posix
  100.     #path: /data/agola/configstore/ost
  102.     # s3 based object storage
  103.     type: s3
  104.     # example with minio
  105.     endpoint: "http://yourminio:9000"
  106.     bucket: configstore
  107.     accessKey: minio
  108.     secretAccessKey: minio123
  110.   web:
  111.     listenAddress: ":4000"
  113. executor:
  114.   # local data directory
  115.   dataDir: /data/agola/executor
  116.   # The directory containing the toolbox compiled for the various supported architectures
  117.   toolboxPath: ./bin
  118.   runserviceURL: "http://runservice:4000"
  119.   web:
  120.     listenAddress: ":4001"
  121.   activeTasksLimit: 2
  122.   driver:
  123.     type: docker
  124.   # allow to run privileged containers
  125.   allowPrivilegedContainers: false
  127. gitserver:
  128.   # local data directory
  129.   dataDir: /data/agola/gitserver
  130.   gatewayURL: "https://youragola.com"
  132.   web:
  133.     listenAddress: ":4003"