Connect GitHub Enterprise (Cloud & Server) | Aikido
Connect GitHub Enterprise (Cloud & Server)
Aikido integrates with Github Enterprise Cloud and GitHub Enterprise Server through a secure, app-based connection. This allows Aikido to access the repositories you choose while keeping full control.
Please make sure that you have sufficient permissions in the GitHub Server Organizations to install apps. This can usually only be done by organization admin and owners.
Aikido connects to your GitHub Enterprise setup by creating a GitHub App on your server. The app includes the permissions and callbacks needed for Aikido to work. After it is created, you can install it in any organisation on your GitHub Server instance that you want to link to Aikido. To create the GitHub app on your instance, follow the steps below.
Create your account
If you don’t have an Aikido account yet, create one through Google or Microsoft first. This is required before you can connect your GitHub Enterprise Server.
Open the onboarding page and select "GitHub Server", this should bring you to the installation page. Enter the URL of your GitHub Enterprise and click Next, Install App.
If your GitHub Enterprise Server is not reachable from the internet, enable the Broker setting.
For details about how the Aikido Broker works, see the documentation.
Install Aikido Github App on your Github Enterprise
A file named install.html is downloaded to your machine. It contains an HTML page with a form that sends a JSON payload to your GitHub Enterprise to create the GitHub App.
Open the file in your browser and select Install to continue the setup process.
After clicking "Install" you are redirected to a page on your GitHub Enterprise that prompts you to install the app. Choose Create GitHub App for User to create the app on your server.
Authorize Aikido Github app
Now you need to authorize the new GitHub App with your user account through OAuth. This step confirms that the app was created correctly and that you have permission to use it. The screen you see will be similar to the example below.
Connect Github organization
Choose the GitHub organisation where you want to install the application and link it to Aikido. You can add more organisations later. After selecting the organisation, confirm the authorization for the GitHub App.
You are now redirected back to Aikido where you can choose which repositories should be scanned. Select the repositories you want and continue. Aikido will start scanning the chosen applications.
Explore Aikido
After granting access and validating the repositories you want to scan, Aikido will automatically start scanning. After about 1 minute, you should see the first results come in