For the latest updates and improvements, see the latest Cloud documentation instead.
Create and configure a new GitHub App¶
|
Codacy Self-hosted running on Docker stopped being supported on February 16, 2021. If you are a current customer and have any questions regarding the migration process, please reach out to your CSM or success@codacy.com for more information. |
Creating a new GitHub App¶
Navigate to your GitHub installation Settings > Developer Settings > GitHub Apps > New GitHub App or https://github.example.com/settings/apps/new, where github.example.com is your GitHub Enterprise hostname.
| Field | Value |
|---|---|
| GitHub App name | Codacy |
| Homepage URL | https://codacy.example.com |
| User authorization callback URL | https://codacy.example.com |
| Webhook URL | https://codacy.example.com/2.0/events/gh/organization |
| 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 |
Configuring a new GitHub App¶
Configure the name of the created app in Codacy's configuration panel (codacy.example.com:9000).
Update both Client ID and Client Secret with the ones generated by the new App (codacy.example.com/admin/integrations).
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.
If you have a question or need help please contact support@codacy.com.