Skip to content

OAuth Providers

Jump to bottom
Ryan Wold edited this page Nov 5, 2019 · 6 revisions

As open-source software, Touchpoints supports 2 OAuth providers to authenticate users:

  1. Login.gov
  2. GitHub

For cloud.gov deployments, only Login.gov is used. But, GitHub is supported to allow other developers to use and contribute readily to this open-source project, outside of a Federal government context.

Configuring GitHub

This is an example of configuring an application for your own development.

  • Visit https://github.com/settings/apps
  • Click OAuth Apps
  • Click New OAuth App
  • Fill out the following information
    • Application name = my test app
    • Homepage URL = http://localhost:3000
    • Application Decription = a description of your choosing
    • Authorization Callback URL = http://localhost:3000/users/auth/github/callback (note the github)

After completing these steps, you will receive a GITHUB CLIENT ID and a GITHUB SECRET. Set these optional environment variables in your project environment. Touchpoints looks for the GITHUB_CLIENT_ID to enable GitHub as an OAuth provider.

Notes

⚠ While Touchpoints can enable both Login.gov and GitHub as OAuth providers, each user can only use 1 authentication provider, not both. (For Developers in development, it is recommended to use 2 accounts, or delete your User account to test both providers.

Clone this wiki locally