These docs are for AuthRocket 1. Looking for AuthRocket 2 docs?

Authenticating with GitHub

Connecting GitHub to AuthRocket allows your users to login to your app using their GitHub login. It’ll take just a few minutes in your browser, and takes no coding at all.

This guide assumes you’re using LoginRocket (our hosted login pages).

If you’re not using LoginRocket, you may want to at least start with it so you’ll know everything is working. Then, go back and adjust for either authrocket.js (see details on Social Logins) or self-hosted logins.

1. Create an App in AuthRocket

If you already have at least one Connected App, you can skip to the next step.

Otherwise, create a Connected App. Start by clicking on Connected Apps. Then click Add App.

The name field will become the header on the login page. You probably want to use the name of your app.

For subdomain, you may either leave it blank (which will cause it to be auto-generated) or use some variant of your app’s name. If unsure, just leave it blank.

Also add the login handler URL.

Our example here shows http://localhost:3000/login. You should adjust these to fit your development environment. In production, you’ll use a production URL.

As you probably noticed, we included /login in our example. Feel free to adjust this to fit your app or framework. These can easily be changed later if necessary, so won’t worry if you’re not yet sure what to use.

2. Add GitHub to AuthRocket

Next, click on Auth Providers and then on the Add button next to GitHub.

Leave this here. Next we’re going to tell GitHub about your app and we’ll need to add the Callback URL from this page to the GitHub App configuration. We’ll come back to this page to fill in the rest of the fields in a moment.

3. Create an App within GitHub

Open another browser tab to GitHub’s app configuration and login.

Then, click on Register New Application.

Fill in your app’s name and URL.

Copy and paste the Callback URL from AuthRocket (where we ended at step 2) into the Authorization Callback URL field.

Scroll to the bottom and click Register Application.

4. Tell AuthRocket about your GitHub App

After adding, you should be shown an Application Details screen.

Copy and paste the Client ID and the Client Secret into their matching fields back in AuthRocket (same page where we left off). Click Add.

5. Test it out

That’s it. Go to your LoginRocket page and you should see Login with GitHub. Click it, login to GitHub, and allow the login. If your app already accepts logins, you should be logged in. Even if not, you should see the user under Users in AuthRocket.

6. Final steps

If you created your GitHub App on your personal GitHub account, you might want to transfer ownership to an Organization before going live.

You may also want to add your app’s logo to your GitHub App so it can be displayed on the login authorization page.

Congratulations, you’re done adding GitHub logins to your app!

Questions? Find a Typo? Get in touch.