Skip to content
CloseYourItdocsPages
Back to the siteENITSelf-host

Documentation / Connect

GitHub

Connect GitHub repositories to tickets and releases with your own GitHub App.

GitHub links repositories to projects, branches and pull requests to tickets, and releases to deploys. Each install uses its own GitHub App, created once by the administrator.

Create the App

  1. On GitHub: Settings → Developer settings → GitHub Apps → New GitHub App.
  2. Callback URL: https://<your-domain>/member/integrations/github/callback, and tick Request user authorization (OAuth) during installation: CloseYourIt checks that whoever installs the App owns the account.
  3. Webhook URL: https://<your-domain>/github/webhook, with a secret you generate.
  4. Repository permissions: Contents read and write, Pull requests read and write, Actions read, Environments and Secrets read and write (to sync ingest tokens), Metadata read.
  5. Events: Push, Create, Release, Pull request.
  6. Create it, then generate a private key and a client secret.

Connect it

Add these to /opt/closeyourit/.env and run closeyourit restart:

VariableValue
GH_APP_IDthe App ID
GH_APP_SLUGthe name in the App address
GH_APP_PRIVATE_KEYthe private key, on one line with \n
GH_APP_CLIENT_IDthe Client ID shown on the App page
GH_APP_CLIENT_SECRETthe client secret
GH_WEBHOOK_SECRETthe webhook secret

Until these are set, the GitHub page in the app says that GitHub is not connected.