Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 4.11 KB

README.md

File metadata and controls

55 lines (40 loc) · 4.11 KB

pydisgit

pydisgit is a port of the disgit tool to Python on a Quart/ASGI stack. As with the original, pydisgit is a webook proxy for sending GitHub messages to Discord that provides higher quality results than the built-in GitHub endpoint that Discord offers.

This additionally leaves it fully independent of the Cloudflare environment, and lets us use the (subjectively) superior and more reliable Python ecosystem.

usage

pydisgit is published as a Docker image ready to go under ghcr.io/kyoripowered/pydisgit:latest.

environment variables

pydisgit has the following optional environment variables that you can use to customize your instance:

  • PYDISGIT_IGNORED_BRANCHES_REGEX - A regex pattern for branches that should be ignored
  • PYDISGIT_IGNORED_BRANCHES - A comma seperated list of branches that should be ignored
  • PYDISGIT_IGNORED_USERS - A comma seperated list of users that should be ignored
  • PYDISGIT_IGNORED_PAYLOADS - A comma seperated list of webhook events that should be ignored

deployment

Some example unit files for deployment under Podman Quadlet with systemd socket activation behind an Ngnix reverse proxy are provided in the `etc/deployment folder. By default, the docker image will bind to port 8000 if it's used on its own.

We recommend choosing a webhook secret to prevent unauthorized users from exhausting the host server's available ratelimit space.

licensing

pydisgit is released under the terms of the Apache Software License version 2.0. Thanks additionally go out to JRoy and all other contributors to upstream disgit for making it what it is today.

Supported Events

The following webhook events are supported as of now: