Skip to content
LogScale Self-Hosted
This is an archived version of the documentation downloaded from LogScale Documentation Archives. Up to date documentation, and documentation for later versions, is available on LogScale Documentation

### Authenticate with GitHub sign-in

Step-by-step instructions for implementing GitHub Sign-In authentication in LogScale through OAuth App configuration. The process includes creating an OAuth App in GitHub settings, setting up the authorization callback URL, and configuring LogScale with the appropriate authentication parameters including client ID, client secret, and optional HTTP proxy settings.

To use GitHub as a single sign-on method with LogScale you first need to create an OAuth app in GitHub. Then you must configure LogScale with the metadata created as part of that app.

#### Create a GitHub app

1. Create an OAuth App from your organization/user settings page. See Creating an OAuth App for setup instructions.

2. Set the Authorization callback URL: `%PUBLIC_URL%/auth/github`

#### Configure LogScale to authenticate with GitHub

Once your app is created you can configure LogScale to authenticate with GitHub. This is configured through configuration variables in the LogScale configuration. To learn more about setting configuration, see Configuration Settings.

Edit the LogScale configuration file to include the following lines:

ini

    AUTHENTICATION_METHOD=oauth
    PUBLIC_URL=$YOUR_SERVERS_BASE_URL
    GITHUB_OAUTH_CLIENT_ID=$CLIENT_ID # The client_id from your GitHub OAuth App
    GITHUB_OAUTH_CLIENT_SECRET=$CLIENT_SECRET # The client_secret from your GitHub OAuth App
    AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN=true  # default is false

To have calls to the token endpoint for GitHub use the cluster's HTTP proxy settings, add the `GITHUB_OAUTH_USE_HTTP_PROXY` configuration and set the value to true.

#### Enter search term