How to create a GitHub Enterprise OAuth application for Swimm
To authorize GitHub Enterprise for your organization, we will need you to create an OAuth application on your GitHub instance. Please follow these steps:
Create GitHub OAuth App
Create Application (3 steps)
- Create OAuth App
- Application Form
- Info for Swimm
- Navigate to your Organization's Account settings page and click
Developer Settings > OAuth Apps - Click
Register an applicationorNew OAuth App(if you already have existing apps).
Fill out the form with the details below:
- Application name: Swimm
- Homepage URL: https://app.swimm.io/
- Application description: Swimm OAuth Application
- Authorization callback URL:
| Network restrictions | Communicate with GitHub | Callback URL |
|---|---|---|
| No | - | https://app.swimm.io/githubAuth |
| Yes (a) | Whitelist Swimm's static IP address (Instructions) | https://app.swimm.io/githubAuth |
| Yes (b) | Swimm OAuth Local Server with a dedicated Docker container (Instructions) | https://app.swimm.io/onpremOAuthCallback |
Lastly, click Register application.
After registering the application, you will be redirected to the Swimm OAuth application page. Here you will find the Client ID and Client Secret that you'll add to the Swimm on-prem agent along with your server information in the final step.
- Upload the Swimm logo to the application: transparent or blue background.
- Click
Generate a new client secret Copy the Client ID and Client Secret - you'll add these to the Swimm on-prem agent in the final step.
Reference: GitHub Docs - Creating an OAuth app
Final Step: Send information to Swimm
1. Git hosting server URL
- HTTPS and publicly accessible for the Swimm web application to connect to your repositories.
2. On-prem Agent service URL
- Install the Swimm on-prem agent.
- Must be deployed with HTTPS/TLS using a certificate trusted by your organization's computers.