Github Runner Webhook Gateway

Canonical IS DevOps Publisher

Platform:

Channel Revision Published Runs on
latest/edge 175 Today
Ubuntu 24.04 
juju deploy github-runner-webhook-gateway --channel edge

Learn to deploy on juju >

Learn about configurations >

  • app-port | int

    Default: 8080

    Default port where the application will listen on.

  • app-secret-key | string

    Long secret you can use for sessions, csrf or any other thing where you need a random secret shared by all units

  • app-secret-key-id | secret

    This configuration is similar to app-secret-key, but instead accepts a Juju user secret ID. The secret should contain a single key, "value", which maps to the actual application secret key. To create the secret, run the following command: juju add-secret my-app-secret-key value=<secret-string> && juju grant-secret my-app-secret-key my-app, and use the output secret ID to configure this option.

  • github-app-id | int

    The ID of the GitHub App to use for communication with GitHub. If provided, the other github-app-* options must also be provided. The GitHub App needs to have write permission for Webhooks. This option is required with the other github-app-* options.

  • github-app-installation-id | int

    The app installation ID of the GitHub App to use for communication with GitHub. If provided, the other github-app-* options must also be provided. The GitHub App needs to have write permission for Webhooks. This option is required with the other github-app-* options.

  • github-app-private-key | secret

    The juju secret id of the private key to use for communication with GitHub. If provided, the other github-app-* options must also be provided. The GitHub App needs to have write permission for Webhooks. This option is required with the other github-app-* options.

  • github-path | string

    The path of the organisation or repository where the webhooks are registered. Format: <organisation> or <organisation>/<repository>.

  • metrics-path | string

    Default: /metrics

    Path where the prometheus metrics will be scraped.

  • metrics-port | int

    Default: 8080

    Port where the prometheus metrics will be scraped.

  • redelivery-interval | int

    Default: 600

    Interval in seconds between redelivery checks. Defaults to 600 (10 minutes).

  • webhook-id | int

    The ID of the webhook for which delivery attempts are being checked.

  • webhook-secret | secret

    The secret used to validate the webhook