Skip to content

Github Integration Setup

In order to setup Github submission, you will first need to create a Github Application and get its corresponding Client ID and Client Secrets. After that, you only need to update the .env file with the information. The full steps are given in the following sections.

Creating your Github Application

  1. Navigate to the Github developer settings in order to create a new OAuth app

  2. Fill in the required form fields:

    • Homepage URL should be the URL that Autolab will be served on (i.e
    • Authorization callback URL is the URL that Github will make a callback to after authentication, which must be the homepage URL appended with /users/github_oauth_callback (i.e [
    • Application name and description should be something helpful to allow students to trust the OAuth application (i.e CMU Autolab)

    An example:

    Github OAuth Setup

  3. After registering the application, you will now have a Client ID for your application. Create a Client Secret for the Client ID, you should see something like the following:

    Github OAuth Secrets

Configuring Github Integration for Autolab

  1. Ensure that you already have the Github application credentials set up based on the previous section

  2. On Autolab, navigate to Manage Autolab > Configure Autolab > Github Integration

  3. Enter your Github Client ID and Client Secret into the corresponding fields and click Save

  4. Under Github Integration Status, you should now see Autolab is connected to Github!