GitHub OAuth application

We use GitHub OAuth application for authentication. You need to configure one for your Local (only if you run API locally) or GCP Dev environments. This document describes how to do that.

Create new GitHub OAuth application

1. Go to your profile's settings
2. Developer settings -> OAuth Apps -> New OAuth app
3. Application name: some name just for GitHub
4. Homepage URL: WebApp_URL/app
5. Authorization callback URL: WebApp_URL/api/auth/login/provider/github/callback
6. Click "Register application"
7. Client ID will be visible on the page (e.g. 895088f0046818e7eefb) - save it
8. Click "Generate a new client secret" and save Client Secret (e.g. 09137e821fafdc2580adaf9779b88b937a756d0f). Make sure to copy your new client secret now. You won’t be able to see it again. If you lose it, just generate a new one.

Example for Local env:

Homepage URL: http://localhost:3000/app
Authorization callback URL: http://localhost:3000/api/auth/login/provider/github/callback

Example for GCP Dev env:

Homepage URL: https://arapi-tenst7-3rnrw36ioq-ew.a.run.app/app
Authorization callback URL: https://arapi-tenst7-3rnrw36ioq-ew.a.run.app/api/auth/login/provider/github/callback

Configure Local environment

Export environment variables for API (use your values):

export AR_AUTH_GITHUB_CLIENT_ID=895088f0046818e7eefb
export AR_AUTH_GITHUB_CLIENT_SECRET=09137e821fafdc2580adaf9779b88b937a756d0f

Configure GCP environment

1. Go to the Secret Manager
2. Find your secrets: arapi-WORKSPACE-auth_github_client_id and arapi-WORKSPACE-auth_github_client_secret
3. Update each key with proper values
   1. Click on the secret
   2. Click "+ New Version"
   3. Provide new secret value
   4. Check "Disable all past versions"
   5. Click "Add New Version"
4. Go to Cloud Run
5. Find your API: arapi-WORKSPACE
6. Deploy new Revision (even with the same image), this will trigger getting new secret values