README.md

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.

Table of contents

• Cheat sheet
• Admin panel
• OAuth providers
• Password reset
• Custom assets
• Custom links
• Fail2ban
• Running using systemd
• Running behind reverse proxy
• Health check

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