Skip to main content

GitHub OAuth

Creating a custom GitHub OAuth application​

  1. Follow GitHub's documentation until the final step of submitting the registration form.
  2. Set the Authorization callback URL to https://idp.ngrok.com/oauth2/callback.
  3. Submit the form. A working example registration:
  4. Save the client ID and client secret from the application overview:

Update your ngrok endpoint traffic policy​

  1. Access the ngrok Dashboard Endpoints page and locate an existing endpoint you'd like to add this to or create a new one.
  2. In your traffic policy, add the following configuration:

Policy​

Loading…

Agent Config​

Loading…
  1. Click Save to validate and update your traffic policy.

Configure access control​

Optionally, configure access control to your service by only allowing specific users or domains. For example:

Policy​

Loading…

Agent Config​

Loading…

Known Limitations​