Google OAuth - Gorbit Documentation

Configure Gorbit to use Google OAuth for user authentication, providing a seamless login experience through existing Google accounts. Prerequisites:

Google Cloud Console access
Administrative permissions to configure OAuth applications

Guide

Create Google Cloud Project

Navigate to the Google Cloud Console Project Creation page and fill in the required fields.

Enable Google People API

Navigate to APIs & Services and find Google People API.Ensure your newly created project is selected in the top bar and click Enable.

Google Cloud Console People API Enable Page

Create Google Auth Platform

Open the left sidebar and navigate to APIs & Services → OAuth Consent Screen.Once on the Overview page, click Get Started.

Google Cloud Console OAuth Consent Screen Page

Configure OAuth Project & Consent Screen

Fill in the App name and User support email fields.Select your Audience. If you have a Google Workspace organization, select Internal. If not, select External.

If you select External, you will need to add your users manually in the Audience tab under Test users.

Fill in any other required fields and finalize the configuration.

Create OAuth Client

Navigate to APIs & Services → OAuth Consent Screen → Clients page.Click ”+ Create Client” and select Web Application.

Google Cloud Console OAuth Client Creation Page

Configure OAuth Client

Name: GorbitAuthorized JavaScript origins and Authorized redirect URIs depend on your deployment environment.If hosting Gorbit locally use:

http://localhost:3000
http://localhost:3000/auth/oauth/callback

If hosting Gorbit on a custom domain use:

https://YOUR_GORBIT_DOMAIN.com
https://YOUR_GORBIT_DOMAIN.com/auth/oauth/callback

Make sure the URIs you enter here match the URI you use to access Gorbit!

Save OAuth Credentials

Click Create → Download JSON to save the OAuth client credentials. Alternatively, save the Client ID and Client Secret to a password or secrets manager.

Configure Gorbit

Configure Gorbit with the following environment variables in your .env or values.yaml file (Docker and Kubernetes, respectively).

.env

AUTH_TYPE=google_oauth
OAUTH_CLIENT_ID=YOUR_CLIENT_ID
OAUTH_CLIENT_SECRET=YOUR_CLIENT_SECRET

# If you are deploying to a custom domain, you will need to set the `WEB_DOMAIN` environment variable.
WEB_DOMAIN=https://YOUR_GORBIT_DOMAIN.com

If you’re using Docker but don’t have a .env file, copy gorbit/deployment/docker_compose/env.prod.template to a new .env file in the same directory.

values.yaml

auth:
  secrets:
    OAUTH_CLIENT_ID: <CLIENT_ID_FROM_GOOGLE>
    OAUTH_CLIENT_SECRET:<CLIENT_SECRET_FROM_GOOGLE>
configMap:
  AUTH_TYPE: google_oauth

Basic Auth OIDC

​Guide

Guide