App Settings

Available Settings

The application can be configured using the following environment variables:

To configure a deployment, see the deployment settings.

See Quickstart to learn how to run the application.

Note

Settings without a default value are required.

Key	Type	Description	Default value
GIT_ACCESS_TOKEN	string	Access token for cloning repositories (required for private repositories), see Access Token Setup
WEBHOOK_SECRET	string	Secret that is used by webhooks for authentication to the application
AUTH_TYPE	string	AuthType is the type of authentication to use when cloning repositories and is added to the clone url before the access token	oauth2
TZ	string	The timezone used in the container and for timestamps in logs	UTC
LOG_LEVEL	string	Log level of the app. Possible values: debug, info, warn, error	INFO
HTTP_PORT	number	Port on which the application will listen for incoming webhooks	80
SKIP_TLS_VERIFICATION	boolean	Skip TLS verification when cloning repositories.	false
DOCKER_QUIET_DEPLOY	boolean	Disable the status output of Docker Compose deployments (e.g. pull, create, start, healthy) in the application logs	true

Specifying the settings

You can set the settings directly in the docker-compose.yml file with the environment option or in a separate .env file with the env_file option.

Both options can be used at the same time.

With env_file

Example with env_file option:

services:
  app:
    env_file:
      - .env

The settings in the .env file should be in the format KEY=VALUE or KEY: VALUE and separated by a newline.

Example .env file:

GIT_ACCESS_TOKEN: xxx
WEBHOOK_SECRET: xxx

With environment

Example with environment option:

services:
  app:
    environment:
      GIT_ACCESS_TOKEN: xxx
      WEBHOOK_SECRET: xxx

Healthcheck endpoint

The application exposes a health check endpoint at /v1/health that, if the application is healthy, returns a 200 status code and the following JSON response:

{
  "details": "healthy"
}

If the application is not healthy, the endpoint returns a 503 status code and the following JSON response:

{
  "details": "unhealthy",
  "error": "some error message"
}