Links
Comment on page

Connect to Github Enterprise Server

Abbey uses a Github App to communicate with PRs. If you are using Github Enterprise Server, you'll need to create an instance of the Abbey Github App inside your instance to allow us to communicate. If you have Github Enterprise Cloud, you do not need to perform these steps since you can use the existing Abbey App.

Installation

In order for Abbey to be able to manage PRs in your Enterprise instance, you'll need to create an Abbey App.
  1. 1.
    Navigate to the Version Control Tab in the Settings Page of the Abbey website and click New Connection
  1. 2.
    Select "Create Github Enterprise App" from the dropdown menu. If the entry instead just says GithubEnterprise, that means that the App is already set up and you can skip to Step 3. Fill out the hostname and name of the organization you want to create the app under then click Create.
Set up Github Enterprise App
Github Enterprise is already set up
  1. 3.
    You will be redirected to github to create your App instance. The required settings have already been selected. Click Create Github App at the bottom to continue.
Github App options
  1. 4.
    In the App settings page, generate a Private Key. This will save a file containing the private key to your computer. Note the Client ID and the App ID at the top of the page. Then return to the Abbey Website.
    Generate a Private Key
  2. 5.
    App ID and Client ID
  3. 6.
    In the App Registration Page, fill out the required info.
    • Hostname and Organization should be the same as previously.
    • The Private Key is in the file downloaded in the previous step.
    • Github Client ID and App ID are found at the top of the App Settings Page.
    Click Create to complete the registration.
App Registration Page
  1. 6.
    Your newly registered app should appear in the integrations table in the Version Control Tab
Integrations Table

Create the App Connection

Follow the instructions in Connect a Repo to connect Abbey to your GitHub account. When selecting which connection you'd like to create, make sure to pick the Github Enterprise option.

Configure Your Grant Kit

When configuring your grant kit, replace instances of github with githubenterprise in URIs.
main.tf
1
resource "abbey_grant_kit" "abbey_demo" {
2
...
3
policies = [
4
- { bundle = "github://replace-me-with-organization/replace-me-with-repo/policies" } # CHANGEME
5
+ { bundle = "githubenterprise://replace-me-with-organization/replace-me-with-repo/policies" } # Use your own organization and repo
main.tf
1
resource "abbey_grant_kit" "abbey_demo" {
2
...
3
output = {
4
# Replace with your own path pointing to where you want your access changes to manifest.
5
# Path is an RFC 3986 URI, such as `github://{organization}/{repo}/path/to/file.tf`.
6
- location = "github://replace-me-with-organization/replace-me-with-repo/access.tf" # CHANGEME
7
+ location = "githubenterprise://replace-me-with-organization/replace-me-with-repo/access.tf" # Use your own organization and repo.
8
append = <<-EOT
9
resource "abbey_demo" "grant_read_write_access" {
10
permission = "read_write"
11
email = "{{ .data.system.abbey.abbey_identity }}"

Configuring Github Actions

In order to use Abbey with Github Actions on Github Enterprise Server, the following additional steps are required.
  1. 1.
    Enable Github Actions in your Server
  2. 3.
    Enable Access to Github.com Based Actions
    1. 1.
      Sync actions with actions-sync
    2. 2.
      Set up Github Connect