Runtime Configuration
GitHub Configuration
Configure Zeeq to with permissions to interact with applications in GitHub.
Summary
Two components need to be configured in GitHub:
- The GitHub App which allows Zeeq to access private repositories
- The GitHub OAuth App which allows users to log in with Zeeq and verify their GH identities (if they created their accounts using other auth providers)
Setup is similar for a dev-instance of the app; replace the
https://app.zeeq.ai base with your proxy to your local dev instance (ngrok, devtunnels, etc.)GitHub App configuration
The GitHub app is required to allow the Zeeq backend to:
- Receive webhooks
- Make API calls to GitHub (read and update PRs, manage check runs, etc.)
- Access private repositories to sync documentation content
| Setting | Example Value |
|---|---|
| Post installation / Setup URL | https://app.zeeq.ai/api/v1/integrations/github/install/callback |
| Post installation / Redirect. on update | ✅ |
| Webhook / Active | ✅ |
| Webhook / Webhook URL | https://app.zeeq.ai/api/v1/integrations/github/webhook |
| Webhook / Secret | (Choose a strong secret) |
Permissions required:
| Permissions | Configuration | Purpose |
|---|---|---|
| Checks | Read and write | Create PR merge checks for Zeeq |
| Contents | Read-only | Read documentation sources from your repositories |
| Issues | Read and write | Read and write issues |
| Pull requests | Read and write | Read comments and write comments to pull requests |
Events required:
- Installation target
- Meta
- Check suite
- Issues
- Issue comment
- Label
- Pull request
- Pull request review
- Pull request review comment
- Pull request review thread
- Workflow job
- Workflow run
After creating the app, note:
| Artifact | Purpose |
|---|---|
| App ID | Needed for configuration of the runtime to create tokens for API calls |
| ClientId | Same as above |
| Slug | The last segment of the public link; required for the token creation process. |
| Private key | Generate a private key which is needed for the token creation process. |
GitHub OAuth App configuration
The OAuth app is used to support user login using GitHub credentials.
| Setting | Example Value |
|---|---|
| Client ID | GitHub generated client ID |
| Client Secret | GitHub generated client secret |
| Application Name | Zeeq AI |
| Authorization callback URL | https://app.zeeq.ai/auth/callback/github |