Configuration

Opengist provides flexible configuration options through either a YAML file and/or environment variables. You would only need to specify the configuration options you want to change — for any config option left untouched, Opengist will simply apply the default values.

The configuration cheat sheet lists all available configuration options.

Configuration via YAML file

The configuration file must be specified when launching the application, using the --config flag followed by the path to your YAML file.

Usage with Docker Compose :

services:
  opengist:
    # ...
    volumes:
    # ...
    - "/path/to/config.yml:/config.yml"

Usage via command line :

./opengist --config /path/to/config.yml

You can start by copying and/or modifying the provided config.yml file.

Configuration via Environment Variables

Usage with Docker Compose :

services:
  opengist:
    # ...
    environment:
      OG_LOG_LEVEL: "info"
      # etc.

Usage via command line :

OG_LOG_LEVEL=info ./opengist

Using Docker Compose secrets

You can use Docker Compose secrets to not expose sensitive information in your compose file, using a .env file.

# file secrets.env
OG_GITLAB_CLIENT_KEY=your_gitlab_client_key
OG_GITLAB_SECRET=your_gitlab_secret_key

And then use it in your compose file :

services:
  opengist:
    # ...
    secrets:
      - opengist_secrets

secrets:
  opengist_secrets:
    file: ./secrets.env