example-config.yaml

# Cloned repo storage directory.
datadir: ./data

# HTTP server configuration.
server:
    # Endpoint for admin API (e.g. dynamically adding webhooks).
    admin_endpoint: /admin
    # Secret for accessing admin API. Admin API is not enabled if this is not set.
    admin_secret: null
    # Endpoint for receiving webhooks.
    webhook_endpoint: /webhook
    # Public URL where the webhook endpoint is accessible. Used for installing GitHub webhooks automatically.
    webhook_public_url: https://example.com/webhook
    # Endpoint for receiving CI status from GitLab.
    ci_webhook_endpoint: /ci/webhook
    # Public URL where the CI webhook endpoint is accessible. Used for installing GitLab webhooks automatically.
    ci_webhook_public_url: https://example.com/ci/webhook
    # Whether or not to trust X-Forwarded-For headers for logging.
    trust_forward_headers: true
    # IP and port where the server listens
    address: :29321

# GitHub app credentials for mirroring CI status from GitLab back to GitHub using the Checks API.
github_app:
    # The numeric app ID.
    id: null
    # RSA private key for the app
    private_key: null

# Shell configuration
shell:
    # The command to start shells with
    command: /bin/bash
    # The arguments to pass to shells. The script is sent through stdin
    args:
    - /dev/stdin
    # Paths to scripts. If unset, will default to built-in handlers.
    #scripts:
    #    push: ./scripts/push.sh

# Repository configuration
repositories:
    githubtraining/hellogitworld:
        # Repository source URL. Optional, defaults to https.
        #source: https://github.com/githubtraining/hellogitworld.git
        # Webhook auth secret. Request signature is not checked if secret is not configured.
        secret: foobar
        # Target repo URL. Required
        target: git@gitlab.com:gitlabtraining/hellogitworld.git
        # Path to SSH key for pushing to repo.
        push_key: ~/.ssh/gitlab_ed25519
        # Path to SSH key for pulling from repo. If set, source repo URL defaults to ssh instead of https.
        #pull_key: ~/.ssh/github_ed25519

# Reverse repository configuration for mirroring CI status back to GitHub.
ci_repositories:
    # The key is the GitLab project ID
    1234:
        # Target GitHub repo owner and name
        owner: githubtraining
        repo: hellogitworld
        # Webhook auth secret.
        secret: foobar
        # GitHub app installation ID. This will be filled automatically if left empty.
        installation_id: 0