Skip to main content

​
Find your GHE.com subdomain

The GHE.com subdomain is the part before .ghe.com in your enterprise’s address. Enter it into your Connector Profile.

  • Format: https://<subdomain>.ghe.com
  • Example: if your address is https://acme.ghe.com, your subdomain is acme

​
Register a GitHub App in your enterprise

Create the app inside the GHE.com enterprise you are connecting, signed in as an organization owner.

1

Start a new GitHub App

Sign in to https://<subdomain>.ghe.com, then open Settings > Developer settings > GitHub Apps.

  • Click New GitHub App.
2

Fill in the basic information

Name the app at the top of the form.

  • GitHub App name: StackOne
  • Homepage URL: your company’s website
3

Set up user authorization

Fill in the Identifying and authorizing users section.

  • Callback URL: copy it from your Connector Profile
  • Leave Expire user authorization tokens selected.
  • Leave Request user authorization (OAuth) during installation cleared.
4

Turn off the webhook

Under Webhook, clear Active.

5

Set permissions for user access reviews

Enables actions: Check Organization Membership, Get Authenticated User, Get Branch, Get Branch Rules, Get Organization, Get Organization Membership, Get Repository, Get Repository Ruleset, Get Team, Get Unified Credentials, Get Unified Group, Get Unified Organization, Get Unified Role, Get User, List Authenticated User Organizations, List Authenticated User Repositories, List Branches, List Collaborators, List Forks, List Organization Branch Protection, List Organization Members, List Organization Members With Two-Factor Status, List Organization Repositories, List Outside Collaborators, List Repository Rulesets, List Team Members, List Team Repositories, List Teams, List Unified Groups, List Unified Organizations, List Unified Roles, List Unified Users, List User Organizations, List User Repositories, List Users, Search Code, Search Issues, Search Repositories

Set each of these to Read-only. Metadata is already Read-only.

  • Organization permissions > Members
  • Account permissions > Email addresses
6

Add permissions for compliance checks

Enables actions: Create Pull Request, Create Pull Request Review, Create Pull Request Review Comment, Get Branch, Get Branch Protection, Get Combined Status For Ref, Get Commit, Get Git Reference, Get Latest Release, Get Organization Ruleset, Get Pull Request, Get Repository, Get Repository Content, List Authenticated User Repositories, List Branches, List Check Runs For Ref, List Commits, List Forks, List Matching Git References, List Organization Audit Log, List Organization Branch Protection, List Organization Repositories, List Organization Rulesets, List Pull Request Reviews, List Pull Requests, List Pull Requests For Commit, List Releases, List Repository Teams, List User Repositories, Merge Pull Request, Search Code, Search Issues, Search Pull Requests With Reviews, Search Repositories, Update Organization, Update Pull Request

Set each repository permission to Read-only, and choose the access for organization Administration.

  • Organization permissions > Administration: Read-only, or Read and write to also read organization rulesets
  • Repository permissions > Administration
  • Repository permissions > Contents
  • Repository permissions > Pull requests
  • Repository permissions > Checks
  • Repository permissions > Commit statuses
7

Add permissions for other actions

Enables actions: Add Collaborator, Add Team Member, Add Team Repository, Cancel Workflow Run, Create Deployment, Create Deployment Status, Create Git Reference, Create Issue, Create Issue Comment, Create Or Update File, Create Organization Repository, Create Pull Request, Create Pull Request Review, Create Pull Request Review Comment, Create Release, Create Team, Create User Repository, Create Webhook, Delete Deployment, Delete File, Delete Git Reference, Delete Release, Delete Repository, Delete Team, Delete Webhook, Download Artifact, Fork Repository, Get Authenticated User, Get Branch, Get Branch Protection, Get Combined Status For Ref, Get Commit, Get Git Reference, Get Issue, Get Latest Release, Get Organization Ruleset, Get Pull Request, Get Repository, Get Repository Content, Get Unified Credentials, Get Webhook, Get Workflow Run, List Artifacts, List Authenticated User Repositories, List Branches, List Check Runs For Ref, List Code Scanning Alerts, List Commits, List Dependabot Alerts, List Deployments, List Forks, List Issue Comments, List Issues, List Matching Git References, List Organization Audit Log, List Organization Branch Protection, List Organization Repositories, List Organization Rulesets, List Pull Request Reviews, List Pull Requests, List Pull Requests For Commit, List Releases, List Repository Teams, List Secret Scanning Alerts, List User Repositories, List Webhooks, List Workflow Jobs, List Workflow Runs, Merge Pull Request, Ping Webhook, Re-run Workflow, Remove Collaborator, Remove Organization Member, Remove Team Member, Search Code, Search Issues, Search Pull Requests With Reviews, Search Repositories, Star Repository, Trigger Workflow, Unstar Repository, Update Code Scanning Alert, Update Dependabot Alert, Update Git Reference, Update Issue, Update Organization, Update Pull Request, Update Release, Update Repository, Update Secret Scanning Alert, Update Team, Update User, Update Webhook

Add these only for the actions you plan to use.

8

Create the app

At the bottom of the form, find Where can this GitHub App be installed?.

  • Select This enterprise.
  • Click Create GitHub App.
9

Copy the credentials

Both credentials are on the app’s page.

  • Copy the Client ID into your Connector Profile.
  • Under Client secrets, click Generate a new client secret.
  • Copy the Client Secret into your Connector Profile. GitHub shows it only once.
10

Install the app

In the app’s sidebar, open Install App.

  • Click Install next to each organization StackOne should read.
  • Select All repositories.
  • Click Install.

​
Create the StackOne Connector Profile

1

Create a Connector Profile

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
2

Link an Account

Once the Connector Profile is created, continue to link an account.