Skip to content
This documentation applies to Codacy Self-hosted

For the latest updates and improvements, see the latest Cloud documentation instead.

Configuring GitHub Cloud with Codacy Self-hosted

Codacy Self-hosted running on Docker stopped being supported on February 16, 2021.

Click here for updated documentation on how to install and configure Codacy Self-hosted on Kubernetes or MicroK8s.

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.

Configuring GitHub Cloud allows you to easily add GitHub repositories to your Self-hosted installation.

To get started, navigate to the Integrations page in the Administration view and select GitHub Cloud.

Screen_Shot_2018-07-08_at_16.39.35.png

First, you'll have to create a GitHub OAuth application. Create an application here.

Fill all the fields with the text shown in the image below or use your own text except for the field Authorization callback URL, where you must insert your local Codacy deployment URL.

The URL should contain the endpoint/IP, the protocol (HTTP or HTTPS) and, if applicable, the port where it is running.

Correct:

Incorrect:

  • your.codacy.url.com
  • your.codacy.url.com:9000
  • 53.43.42.12
  • 53.43.42.12:9000

Screen_Shot_2018-07-08_at_16.45.35.png

After the application is created you should copy both the Client ID and the Client Secret, paste them in the setup page of your Codacy Self-hosted, and click Test and Save.

Login to Codacy

If you only have the GitHub cloud integration enabled the only way you will have to login in Codacy is through Username + Password.

Screen_Shot_2019-08-08_at_15.36.56.png 

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?

We're sorry to hear that. Please let us know what we can improve:

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.

Last modified January 14, 2022