GUIDE_OAUTH.md

Guide: OAuth

GitHub

Read on sergiodxa/remix-auth-github and GitHub Docs for Creating an OAuth app

Create a new OAuth App on Developer applications.

Get the Client ID and generate the Client Secret.

GITHUB_CLIENT_ID="replace_this"
GITHUB_CLIENT_SECRET="replace_this"

Make sure to setup the correct URLs.

• Homepage URL: https://example.com
• Authorization callback URL: https://example.com/auth/github/callback

GitHub doesn't allow to have more than 1 URI per Client ID. So just need to create another for different environments (local, staging, production).

Google

Read on remix-auth-google and Google for Developer Docs for Using OAuth 2.0 for Web Server Applications

1. Go to the Credentials page.
   • Create a Project first if not yet any.
2. In the APIs & Services: Credentials page page, Create credentials > OAuth client ID.
3. To create an OAuth client ID, configure the consent screen.
   • User Type: External
   • App name
   • User support email
   • App logo
   • App domain
   • Authorized domains
   • Developer contact information
   • Scopes:
     • auth/userinfo.email
     • auth/userinfo.profile
     • openid
4. Select the Web application application type.
5. Fill in the form and click Create.
   • Name: The name of your OAuth 2.0 client
   • Authorized JavaScript origins:
     • http://localhost:3000
     • https://example.com
     • https://staging.example.com (optional)
   • Authorized redirect URIs:
     • http://localhost:3000/auth/google/callback
     • https://example.com/auth/google/callback
     • https://staging.example.con/auth/google/callback (optional)

The redirect URIs are the endpoints to which the OAuth 2.0 server can send responses. These endpoints must adhere to Google’s validation rules. You can also specify URIs that refer on local such as http://localhost:3000.

Google allows to have more than 1 URI per Client ID. Although it might be better to adjust for different environments (local, staging, production).

Get the Client ID and generate the Client Secret.

GOOGLE_CLIENT_ID="replace_this"
GOOGLE_CLIENT_SECRET="replace_this"