Skip to content

GitHub Enterprise

Follow the instructions below to set up the Codacy integration with GitHub Enterprise:

  1. Follow the instructions on creating a GitHub App.

  2. Edit the file values-production.yaml that you used to install Codacy.

  3. Set global.githubEnterprise.enabled: "true" and define the remaining values as described below using the information obtained when you created the GitHub App:

      enabled: "true"
      login: "true" # Show login button for GitHub Enterprise
      hostname: "" # Hostname of your GitHub Enterprise instance
      protocol: "https" # Protocol of your GitHub Enterprise instance
      port: 443 # Port of your GitHub Enterprise instance
      disableSSL: "false" # Disable certificate validation
      isPrivateMode: "true" # Status of private mode on your GitHub Enterprise instance
      clientId: "" # GitHub App Client ID
      clientSecret: "" # GitHub App Client secret
        name: "codacy" # GitHub App name
        id: "1234" # GitHub App ID
        privateKey: "" # Contents of the .pem file without newlines
  4. Apply the new configuration by performing a Helm upgrade. To do so execute the command used to install Codacy:


    If you are using MicroK8s you must use the file values-microk8s.yaml together with the file values-production.yaml.

    To do this, uncomment the last line before running the helm upgrade command below.

    helm upgrade (...options used to install Codacy...) \
                 --version 2.1.1 \
                 --values values-production.yaml \
                 # --values values-microk8s.yaml

After this is done you will be able to use GitHub Enterprise to authenticate to Codacy.

Last update: September 29, 2020