GitHub Enterprise Integration

Documentation Index

Fetch the complete documentation index at: https://docs.envzero.com/llms.txt

Use this file to discover all available pages before exploring further.

​

GitHub Enterprise Setup

1. Create GitHub App
   1. Name your GitHub app env zero
   2. Set Homepage URL to https://env0.com
   3. Skip ahead to the Webhooks section
      • Make sure Active is checked
      • You will now need to set the Webhook URL and Secret.
      • To fetch these, go to the VCS Create Connection.
   4. Skip ahead to the Repository permissions section and grant the following permissions:
      • Checks - Read and write
      • Contents - Read-only (For “Code Write”, select Read and Write. If you changed this after the initial installation, you must reinstall the GitHub application).
      • Deployments - Read and Write
      • Metadata - Read-only
      • Pull requests - Read and Write
   5. Skip ahead to the Subscribe to events section and check the following:
      • Push
      • Pull Request
      • Pull request review comment - In case you want to enable Plan and Apply from PR comments
   6. On “Where can this GitHub App be installed?” Check “Any account - Allow this GitHub App to be installed by any user or organization.”. Note however - currently you may only install the app on a single organization of your choice on your GitHub Enterprise instance
   7. Click “Create GitHub App”
   8. Make a note of the App ID
   9. Scroll all the way down and “Click the Generate a private key”. A pem file will be downloaded and saved on your computer. You’ll need it later.
   10. Under the “Display information”, click the “Upload a logo…” button and upload a logo (Optional)
2. On the lefthand side menu, click on Install App to install the app on any organization of your choice
   1. Grant env zero access to all or selected repositories in the organization.
   2. Ensure you have granted permission for any organization’s repository you need access to. If permission is not granted for a specific repository, you may encounter a ‘Not Found’ error at certain points.
   
3. You’ll need the following set as Helm values when installing the env zero agent:
   • githubEnterpriseAppId - The App ID from step 1.8
   • githubEnterpriseAppPrivateKeyEncoded - The content of the pem file downloaded in step 1.9 Please base64 encode it before setting it
   • githubEnterpriseAppInstallationId - (Optional) You can restrict permissions to a single installation ID through this configuration.

btoa("secret")

base64 -i private.pem

githubEnterpriseAppId: 111
githubEnterpriseAppPrivateKeyEncoded: aa==
githubEnterpriseAppInstallationId: 222 # Optional 

GITHUB_ENTERPRISE_APP_ID=111
GITHUB_ENTERPRISE_APP_PRIVATE_KEY=aa==

# optional
GITHUB_ENTERPRISE_APP_INSTALLATION_ID=222

4. Install the agent

​

Next steps

• Standard GitHub Integration - Connect cloud-hosted GitHub repositories.
• Managing VCS - Manage all VCS provider connections in one place.
• Self-Hosted Kubernetes Agent - Deploy the agent required for self-hosted VCS.