Skip to main content
Your dedicated Ryvn hub connects to GitHub through a GitHub App that your organization owns. This page creates it with the settings pre-filled; you review and confirm on GitHub, then send the generated credentials to Ryvn.
You need owner permission on the GitHub organization and the hub domain Ryvn gave you (for example acme.ryvn-abc12.ryvn.run). If you are not an organization owner, forward the manual setup section below to someone who is.
1

Create the App

Fill in the three fields and click Create on GitHub. A review page shows the settings that will be applied; click Create on GitHub there, and on GitHub’s Register new GitHub App page click Create GitHub App for <org>.
Check the hub domain before you create the App. It decides where GitHub sends webhooks and installation callbacks. Only use the domain Ryvn gave you directly, never one from an unsolicited link.
2

Convert the one-time code into credentials

GitHub sends you back to this page with a code= parameter in the URL, and the form shows the ready-to-run command (valid for one hour, no authentication needed):
ryvn-github-app.json contains everything the hub needs:
Treat this file as a secret and do not commit it. GitHub never shows the private key again; if you lose the file, generate a new private key and client secret from the App’s settings page and read the webhook secret from its Webhook section.
3

Hand the credentials to Ryvn

Send ryvn-github-app.json to your Ryvn contact over the agreed secure channel, never in plain-text email or chat. Ryvn configures your hub with it and tells you when it is live.
4

Install the App from your hub

Sign in to your hub at https://<hub domain>, open Settings → Source control and click Install GitHub App. Select the repositories Ryvn should manage and confirm.
Always start the installation from the hub, not from GitHub’s App page: an installation started on GitHub is not linked to your Ryvn organization. If that happened, uninstall it from the organization’s Installed GitHub Apps page and start again from the hub. You can add repositories later from the installation’s settings page on GitHub.

​
Set up manually

If you prefer to create the App by hand, or need to forward the requirements to an organization owner, use the settings below. Replace <hub> with your hub domain and <slug> with your Ryvn customer slug.
  1. Go to https://github.com/organizations/<org>/settings/apps/new (Organization settings → Developer settings → GitHub Apps → New GitHub App).
  2. Fill in the form:
  3. Set Repository permissions: and Organization permissions: Members → Read-only. Leave everything else at No access.
  4. Subscribe to events: Push and Pull request.
  5. Click Create GitHub App. On the App’s page, note the App ID and Client ID, click Generate a new client secret, then scroll to Private keys and click Generate a private key (downloads a .pem file).
  6. Send the App name, App ID, Client ID, client secret, webhook secret and the .pem file to your Ryvn contact over the agreed secure channel. Once Ryvn confirms the hub is configured, continue with Install the App from your hub above.

​
Updating the App later

When a Ryvn release needs additional permissions or events, Ryvn tells you what to change. Open the App’s Permissions & events page, apply the change and save, then accept the new permissions on the installation page (GitHub emails organization owners a link).