Install Exalate for GitHub


    You can

    • install Exalate for GitHub from the marketplace.
    • install Exalate for GitHub on docker. 

    Then proceed to 

    • generate a personal access token to log into the Exalate admin console.
    • configure proxy user permissions.

    Exalate can be installed on Github Cloud and GitHub Enterprise Cloud.

    Install Exalate from the Marketplace

    Exalate for GitHub is available on the marketplace.

    You can install Exalate for organizations or user accounts and grant access to repositories. The app is hosted on our server.

    To install Exalate, you need to be an organization owner or have admin permissions in a repository.

    1. Click Exalate Issue Sync on the Marketplace

    2. Click Set up a plan

    3. Click Install it for free

    4. Click Complete order and begin the installation

    5. Click Install

    By default, Exalate is installed on the account that is currently logged in.

    To select a different account or organization:

    • Click Cancel.
    • Select the necessary account or organization.

    After clicking Install, you will be redirected to the Exalate admin console. We recommend saving the link to easily access Exalate in the future.

    You can always recover your Exalate app link here:

    You can change the repository access later in your GitHub account under Installed apps → Exalate → Repository access.

    6. Click Authorize Exalate to allow Exalate access to your GitHub account information

    Exalate requires reading and writing permissions to the issues and pull requests on your GitHub instance.

    7. Input your contact details in the Registration screen

    Exalate will send you a verification email. With this info Exalate will:

    • Verify your instance.
    • Activate an evaluation license.
    • Make an admin account to receive error notifications.

    8. Click Agree and submit

    After clicking Agree and submit, you will get an email to complete a security check.

    9. Open your email and click Verify Exalate instance

    You will be redirected back to the Exalate console.

    10. Click Continue

    11. Enter your personal access token in the Token field

    How to Generate a Personal Access Token?

    Personal access tokens are used to log in to Exalate for GitHub.

    1. Log in to your GitHub account.

    The GitHub user must be an organization member or have admin access to a repository where Exalate is installed. 

    The user account that wishes to access the Exalate dashboard needs to have organization visibility set to Public.

    2. Navigate to Settings → Developer settings.

    3. Select Personal access tokens.

    4. Press Generate new token to generate a new access token.

    Select the scopes or permissions you'd like to grant this token. To use your token to access repositories from the command line, select repo.

    Once the token has been generated, you can use it to log in to your Exalate admin console. 

    Make sure to save the token, because you can access it only once.

    Starting from version 5.1.4 we apply security improvements involving migration to OAuth for the Exalate application for Github.

    Configuring Proxy User Permissions

    By default, Exalate for GitHub proxy user is the repository admin or the organization owner, who is installing Exalate.

    Access to GitHub

    Use a personal access token to log in to Exalate for GitHub. The token needs to have access to private repositories with the repo scope.

    Proxy user permissions in GitHub

    The proxy user has the same permissions as an admin or an organization owner in GitHub.

    Install Exalate for GitHub on Docker

    Learn more about How to install Exalate for GitHub on docker

    Video Tutorial