How to integrate the GitHub authentication plugin

1. In the Aiven Client, connect to your [service][Install and configure the Aiven client].

2. Switch to the project that contains the Grafana service you want to integrate:

    avn switch <PROJECT>

3. List the services in the project, and make a note of the Grafana service that you want to integrate, listed under SERVICE_NAME column in the output.

    avn service list

4. Get the details of the service that you want to integrate:

   avn service get <SERVICE_NAME>

5. Integrate the plugin with your service using the <CLIENT_ID>, and <CLIENT_SECRET> from your GitHub OAuth application:

   avn service update -c auth_github.client_id=<CLIENT_ID>\
   -c auth_github.client_secret=<CLIENT_SECRET> <SERVICE_NAME>

6. Log in to Grafana with your service credentials.

7. Navigate to Configuration → Plugins. The Plugins page lists GitHub OAuth application for the Grafana instance.

When you allow sign-ups using the -c auth_github.allow_sign_up=true option, by default each new user is created with viewerpermission and added to their own newly created organizations. To specify different permissions, use -c user_auto_assign_org_role=ROLE_NAME. To add all new users to the main organization, use the -c user_auto_assign_org=true option.

Integrating the GitLab authentication plugin

To integrate the GitLab authentication with Grafana service on Managed Service for TimescaleDB, you need to create your [GitLab OAuth application][gitlab-oauth-keys]. Copy your client ID, client secret, and GitLab groups name to a secure location.

If you use your own instance of GitLab instead of gitlab.com, then you need to set the following:

• auth_gitlab.api_url
• auth_github.auth_url
• auth_github.token_url