Credentials

trac reaches your organisation’s GitHub repositories through a GitHub App that your organisation owns. The same credentials are used when people browse repositories to import a model and when jobs fetch model code to run it, so access doesn’t depend on any individual’s personal GitHub account.

Note

The Community desktop edition uses the GitHub OAuth App instead, with credentials supplied as part of the platform configuration files.

Select ‘Credentials’ from the ‘Platform admin’ menu.

Before you start

Create a GitHub App in your organisation’s GitHub settings and install it on the repositories that hold your models. You will need the following from GitHub:

• the App’s App ID and Client ID

• a client secret generated for the App

• a private key file generated for the App

• the Installation ID of the App’s installation on your organisation

See GitHub’s documentation on registering and installing a GitHub App for the details.

Adding credentials

Click ‘Update GitHub App credentials’, enter the App ID, Client ID, Installation ID and client secret, and load the private key file (.pem, .key or .txt). Click ‘Save GitHub App credentials’.

Once saved, the page shows the current configuration: the App ID, Client ID and Installation ID. The client secret and private key are never shown.

GitHub repositories can now be added as tenant resources.

Replacing or removing credentials

To rotate the client secret or private key, click ‘Update GitHub App credentials’ and save the new values. The change applies to every repository that uses the GitHub App.

‘Remove GitHub App credentials’ deletes them after a confirmation. Browsing repositories and running jobs against them stop working until new credentials are added.