1. Git Connections
Self-hosting Apidog
  • Overview
  • Introduction
    • Obtaining Apidog On-Premises License
    • System Requirements
    • Data Privacy & Compliance
  • Deployments
    • Docker Deployment
      • Standalone Docker Deployment
      • Hybrid Docker Deployment
      • Multi-Containers Docker Deployment
    • Kubernetes Deployment
      • Deploying Apidog on Kubernetes using Deployment Manifest
      • Deploying Apidog on Kubernetes using Helm
  • Post Deployment
    • Accessing Apidog Admin Panel
    • Accessing Apidog Web Interface
    • Installing Apidog On-Premises Client
  • Configurations
    • Environment Variables
    • Database Configuration
    • Storage Services Configuration
    • Authentication Providers
      • Using LDAP for Authentication
      • Using OKTA for Authentication
      • Using OAuth2.0 for Authentication
    • Git Connections
      • Overview
      • GitHub
      • GitLab
      • Azure DevOps
      • Bitbucket (Beta)
  • Maintenance & Upgrades
    • Updating Apidog
    • Backing up Apidog
    • License Renewal
    • System Design Flow
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  • Changelog
    • Apidog On-Premise Changelog Q1 2026 - v2.7.38
    • Apidog On-Premise Changelog Q2 2026 - v2.7.81
    • Apidog On-Premise Changelog Q3 2026 - v2.8.35
  1. Git Connections

GitHub

Version Requirement: The GitHub Git connection requires Apidog On-Premises image version 2.7.72 or later.

GitHub App Configuration (Recommended)#

GitHub App vs OAuth2 App: GitHub App is the newer recommended approach for GitHub integration. It provides more granular permissions and better security. The OAuth2 App configuration below is maintained for backward compatibility with existing setups. Both can be enabled simultaneously.
To integrate with a GitHub App, you need to create a new GitHub App in your GitHub settings. For the GitHub SaaS version, visit:
https://github.com/settings/apps

Creating a GitHub App#

1.
Click New GitHub App and configure the following settings:
GitHub App name: Choose a descriptive name (e.g., Apidog Git Integration)
Homepage URL: https://your-apidog-domain.com/
Callback URL: https://your-apidog-domain.com/passport/github/callback
Request user authorization (OAuth) during installation: ✅ Enable
Post installation — Redirect on update: ✅ Enable
Webhook — Active: ❌ Disable
2.
Set the following permissions:
Repository permissions:
Administration: Read & write
Contents: Read & write
Metadata: Read-only
Webhooks: Read & write
Organization permissions:
Members: Read-only
Account permissions: None required
3.
Under Where can this GitHub App be installed?, select Any account.
4.
Click Create GitHub App.
5.
After creation, note the App ID and App slug (from the URL). Then generate a Client secret under the app settings and note the Client ID.

Environment Variables#

Environment VariableDescriptionDefault ValueNotes
GIT_CONNECTION_GITHUB_APP_ENABLEWhether to enable GitHub App git connectionfalseSet to true to enable GitHub App integration
GITHUB_APP_AUTH_HOSTGitHub App authentication host URLhttps://github.comUse https://github.com for SaaS or your enterprise GitHub host
GITHUB_APP_API_HOSTGitHub App API host URLhttps://api.github.comUse https://api.github.com for SaaS or enterprise host with /api/v3
GITHUB_APP_CLIENT_IDGitHub App client ID-Required — from GitHub App settings
GITHUB_APP_CLIENT_SECRETGitHub App client secret-Required — from GitHub App settings
GIT_CONNECTION_GITHUB_APP_REJECT_UNAUTHORIZEDSSL certificate validation for GitHub AppfalseSet to false for self-signed certificates in enterprise environments
GITHUB_APP_SLUGGitHub App slug identifier-The slug from your GitHub App URL (e.g., my-apidog-app)
GITHUB_APP_IDGitHub App ID-The numeric App ID from your GitHub App settings

Configuration Example for GitHub SaaS Version#

- name: GIT_CONNECTION_GITHUB_APP_ENABLE
  value: 'true'
- name: GITHUB_APP_AUTH_HOST
  value: 'https://github.com'
- name: GITHUB_APP_API_HOST
  value: 'https://api.github.com'
- name: GITHUB_APP_CLIENT_ID
  value: <your-github-app-client-id>
- name: GITHUB_APP_CLIENT_SECRET
  value: <your-github-app-client-secret>
- name: GIT_CONNECTION_GITHUB_APP_REJECT_UNAUTHORIZED
  value: 'false'
- name: GITHUB_APP_SLUG
  value: <your-github-app-slug>
- name: GITHUB_APP_ID
  value: <your-github-app-id>

Configuration Example for GitHub Enterprise Version#

- name: GIT_CONNECTION_GITHUB_APP_ENABLE
  value: 'true'
- name: GITHUB_APP_AUTH_HOST
  value: 'https://github.yourcompany.com'
- name: GITHUB_APP_API_HOST
  value: 'https://github.yourcompany.com/api/v3'
- name: GITHUB_APP_CLIENT_ID
  value: <your-enterprise-github-app-client-id>
- name: GITHUB_APP_CLIENT_SECRET
  value: <your-enterprise-github-app-client-secret>
- name: GIT_CONNECTION_GITHUB_APP_REJECT_UNAUTHORIZED
  value: 'false'
- name: GITHUB_APP_SLUG
  value: <your-enterprise-github-app-slug>
- name: GITHUB_APP_ID
  value: <your-enterprise-github-app-id>

GitHub OAuth2 Configuration (Legacy)#

To integrate with GitHub using an OAuth2 App, you need to create a new OAuth app in the GitHub settings. For the GitHub SaaS version, you can access the settings page using the following URL:
https://github.com/settings/developers.
image.png
When creating the OAuth app, set the Authorization callback URL to your Apidog On-Premises API domain, followed by /passport/github/callback.
For-example: https://your-apidog-domain.com/passport/github/callback
Once the app is created, take note of the Client ID and Client Secret, then configure the following environment variables:
Environment VariableDescriptionDefault ValueNotes
GIT_CONNECTION_GITHUB_ENABLEWhether to enable GitHub Git connectiontrueSet to true to enable GitHub integration
GITHUB_AUTH_HOSTGitHub authentication host URL-Use https://github.com for SaaS GitHub or your enterprise GitHub host
GITHUB_API_HOSTGitHub API host URL-Use https://api.github.com for SaaS GitHub. Or use GITHUB_AUTH_HOST with /api/v3 for enterprise version
GITHUB_KEYGitHub OAuth application client ID-Required for GitHub OAuth authentication
GITHUB_SECRETGitHub OAuth application client secret-Required for GitHub OAuth authentication
GIT_CONNECTION_GITHUB_REJECT_UNAUTHORIZEDSSL certificate validation for GitHubtrueSet to false for self-signed certificates in enterprise environments

Configuration Example for GitHub SaaS Version#

- name: GIT_CONNECTION_GITHUB_ENABLE
  value: 'true'
- name: GITHUB_AUTH_HOST
  value: 'https://github.com'
- name: GITHUB_API_HOST
  value: 'https://api.github.com'
- name: GITHUB_KEY
  value: <your-github-client-id>
- name: GITHUB_SECRET
  value: <your-github-client-secret>
- name: GIT_CONNECTION_GITHUB_REJECT_UNAUTHORIZED
  value: 'true'

Configuration Example for GitHub Enterprise Version#

- name: GIT_CONNECTION_GITHUB_ENABLE
  value: 'true'
- name: GITHUB_AUTH_HOST
  value: 'https://github.yourcompany.com'
- name: GITHUB_API_HOST
  value: 'https://github.yourcompany.com/api/v3'
- name: GITHUB_KEY
  value: <your-enterprise-github-client-id>
- name: GITHUB_SECRET
  value: <your-enterprise-github-client-secret>
- name: GIT_CONNECTION_GITHUB_REJECT_UNAUTHORIZED
  value: 'false'
Modified at 2026-10-26 09:06:51
Previous
Overview
Next
GitLab
Built with