Creating a GitHub App#
You must create and correctly set up a GitHub App to allow Codacy Self-hosted to integrate with GitHub.
To create the GitHub App:
If you're using GitHub Cloud, open https://github.com/settings/apps/new.
If you're using GitHub Enterprise, open
https://github.example.com/settings/apps/new, replacing the HTTP protocol and hostname with the correct values for your GitHub Enterprise instance.
Configure the new GitHub App using the values listed on the table below, replacing
https://codacy.example.comwith the correct base URL of your Codacy instance.
Field Value GitHub App name Codacy Homepage URL
User authorization callback URL
Request user authorization (OAuth) during installation Enabled
Make sure this option is selected to request that the installing user grants access to their identity during the installation of your Codacy GitHub App.
Webhook URL For GitHub Cloud:
For GitHub Enterprise:
Repository permissions Administration Read & write Checks Read & write Issues Read & write Metadata Read only Pull requests Read & write Webhooks Read & write Commit statuses Read & write Organization permissions Members Read only Webhooks Read & write User permissions Email addresses Read only Git SSH keys Read & write Where can this GitHub App be installed? Any account
Scroll to the bottom of the page, click Generate a private key, and save the
.pemfile containing the private key.
Take note of the following information, as you'll need it to configure Codacy:
- GitHub App name
- App ID
- Client ID
- Client secret
- Private key (contents of the
.pemfile generated in the previous step)
Share your feedback 📢
Did this page help you?
Thanks for the feedback! Is there anything else you'd like to tell us about this page?
255 characters left
We're sorry to hear that. Please let us know what we can improve:
255 characters left
Alternatively, you can create a more detailed issue on our GitHub repository.
Thanks for helping improve the Codacy documentation.
Edit this page on GitHub if you notice something wrong or missing.
If you have a question or need help please contact email@example.com.