Skip to main content

Check out Port for yourself ➜ 

Custom Github App

This page details how to install Port's GitHub integration using a custom GitHub App, which provides automatic access token rotation.

This page outlines the following steps:

  1. How to create a new app in your GitHub organization;
  2. How to install the GitHub app in your GitHub organization and select repositories.
  3. How to deploy the integration in the configuration that fits your use case.

Prerequisites​

  • A GitHub account with permissions to create and manage GitHub Apps in your organization. This typically requires being an Organization Owner or having the "App Manager" role.
  • Your Port user role is set to Admin.

Create a GitHub app​

  1. Navigate to your Github organization and click on Settings:

Org view

  1. Inside the settings view, click on Developer Settings -> and then select GitHub Apps:

Settings view

  1. Click on "New GitHub App":

New GitHub App

  1. Insert the following properties:
  • GitHub App name: Choose a unique name for the app. Note that GitHub App names must be globally unique.
  • Homepage URL: https://port.io
  • Callback URL: Leave this empty.
  • Setup URL: Leave this empty.
  • Uncheck Active under Webhooks. The integration will automatically create the webhook if you configure the OCEAN__BASE_URL variable later during deployment.
  • Repository Permissions:
    • Actions: Readonly (for syncing Workflows).
    • Checks: Readonly (for syncing Port.yml).
    • Contents: Readonly (for reading port configuration files and repository files).
    • Metadata: Readonly.
    • Administration: Readonly (for syncing collaborators)
    • Pull Request: Readonly
    • Code scanning alerts: Readonly
    • Dependabot alerts: Readonly
    • Deployments: Readonly
    • Environments: Readonly
  • Organization Permissions:
    • Members: Readonly (for syncing members and teams).
    • Administration: Readonly(for syncing external identities)
    • Webhooks: Read and Write (to allow the integration create webhook).

Then select "Create GitHub App"

  1. Go to the Private keys at the bottom of the General settings page:

Generate Private key

Keep the file, you will need it for the deployment step.

Installing GitHub App​

After you have the app registered in your organization, you can install it and select the repositories to integrate it with:

  1. First, navigate to your organization and click on Settings:

Org view

  1. Inside the settings view, click on Developer Settings -> and then select GitHub Apps:

Settings view

  1. Click edit on the GitHub app created at the step before:

GitHub integration installation page

  1. Go to Install App -> and select the installation button on your wanted organization;

  2. Choose the repositories you want the integration to be installed for:

GitHub integration installation chooses repositories

Deploy the integration​

To deploy the integration, you will need your Port CLIENT_ID and CLIENT_SECRET.

To get your Port credentials, go to your Port application, click on the ... button in the top right corner, and select Credentials. Here you can view and copy your CLIENT_ID and CLIENT_SECRET:

Choose the installation method that best suits your needs:

Using this installation option means that the integration will be hosted by Port, with a customizable resync interval to ingest data into Port.

Live event support

This integration supports live events, allowing real-time updates to your software catalog without waiting for the next scheduled sync.

Supported live event triggers (click to expand)

repository:

  • created
  • edited
  • renamed
  • transferred
  • unarchived
  • publicized
  • privatized
  • archived
  • deleted

pull_request:

  • opened
  • edited
  • ready_for_review
  • reopened
  • synchronize
  • unassigned
  • review_request_removed
  • closed

issues:

  • assigned
  • closed
  • demilestoned
  • edited
  • labeled
  • locked
  • milestoned
  • opened
  • pinned
  • reopened
  • transferred
  • typed
  • unassigned
  • unlabeled
  • unlocked
  • unpinned
  • untyped
  • deleted

release:

  • created
  • edited
  • deleted

create

delete

push

deployment

deployment_status

workflow_run:

  • in_progress
  • requested
  • completed

dependabot_alert:

  • created
  • reopened
  • auto_reopened
  • reintroduced
  • dismissed
  • auto_dismissed
  • fixed

code_scanning_alert:

  • appeared_in_branch
  • reopened
  • created
  • fixed
  • closed_by_user

organization:

  • member_added
  • member_removed

team:

  • created
  • edited
  • deleted
  • added_to_repository

membership:

  • added
  • removed

member:

  • added
  • edited
  • removed

secret_scanning_alert:

  • created
  • publicly_leaked
  • reopened
  • validated
  • resolved
Self-hosted installation

Alternatively, you can install the integration using the Self-hosted method to update Port in real time using webhooks.

Installation

To install, follow these steps:

  1. Go to the Data sources page of your portal.

  2. Click on the + Data source button in the top-right corner.

  3. Click on the relevant integration in the list.

  4. Under Select your installation method, choose Hosted by Port.

  5. Configure the integration settings and application settings as you wish (see below for details).

Application settings

Every integration hosted by Port has the following customizable application settings, which are configurable after installation:

  • Resync interval: The frequency at which Port will ingest data from the integration. There are various options available, ranging from every 1 hour to once a day. If a sync is still in progress when the next one is due, the new sync will be skipped (up to 24 hours delay).
    This ensures that all kinds are fully synchronized and that cleanup of stale entities always takes place at the end of each sync.

  • Send raw data examples: A boolean toggle (enabled by default). If enabled, raw data examples will be sent from the integration to Port. These examples are used when testing your mapping configuration, they allow you to run your jq expressions against real data and see the results.

Integration settings

Every integration has its own tool-specific settings, under the Integration settings section.
Each of these settings has an ⓘ icon next to it, which you can hover over to see a description of the setting.

Port secrets

Some integration settings require sensitive pieces of data, such as tokens.
For these settings, Port secrets will be used, ensuring that your sensitive data is encrypted and secure.

When filling in such a setting, its value will be obscured (shown as ••••••••).
For each such setting, Port will automatically create a secret in your organization.

To see all secrets in your organization, follow these steps.

Limitations

  • The maximum time for a full sync to run is based on the configured resync interval. For very large amounts of data where a resync operation is expected to take longer, please use a longer interval.

Port source IP addresses

When using this installation method, Port will make outbound calls to your 3rd-party applications from static IP addresses.
You may need to add these addresses to your allowlist, in order to allow Port to interact with the integrated service:

54.73.167.226  
63.33.143.237  
54.76.185.219