Documentation

Configuration

Configure the self-hosted server.

Self-hosted deployments use config.yaml to define providers, storage, drivers, and optional OAuth redirects. This layout mirrors the OSS examples in the README and docs/getting-started-github.md.

server:
  port: 8080
endpoint: https://<your-public-url>

providers:
  github:
    webhook:
      secret: devsecret
    app:
      app_id: YOUR_APP_ID
      private_key_path: /path/to/github.pem
      app_slug: your-app-slug
    api:
      base_url: https://api.github.com
    oauth:
      client_id: your-oauth-client-id
      client_secret: your-oauth-client-secret

watermill:
  driver: amqp
  amqp:
    url: amqp://guest:guest@localhost:5672/
    mode: durable_queue

storage:
  driver: postgres
  dsn: postgres://githook:githook@localhost:5432/githook?sslmode=disable
  dialect: postgres
  auto_migrate: true

redirect_base_url: https://app.example.com/success

Notes:

  • endpoint must be your public base URL. It is used to build webhook and OAuth callback URLs.
  • redirect_base_url controls where users are sent after OAuth completes.
  • Keep secrets in environment variables and inject them at runtime.