Skip to content

Git Authentication

Development environments on Diploi are remote (run on a specified Core, not your local machine), and thus do not inherit your local Git configuration. You have most likely done this first-time setup with Git in the past, but for those who havent, or those who want a refresher, we have collected information about these steps below.

Firstly, Git requires you to input your username and email which will be included with every commit you make. Diploi can do this automatically for you, but you can also opt-out and fill in the information yourself.
You can read more about this step here.

Secondly, Git requires you to authenticate with the remote repository you are trying to interact with. Usually this is done via SSH keys, and it can certainly be done this way while developing remotely too, it just might not be the most secure solution. Diploi can automate this step too via a repository-specific access token. This token is scoped to a single GitHub repository, and will not grant access to an entire organization or user.
You can choose opt-out of this automation, but you will have to supply an authentication method yourself. You can read more about authenticating with GitHub here.

Assigning a User to a Deployment

This is the easiest way to handle Git configuration, as it will be handled automatically by Diploi. Diploi will use your GitHub email & username to sign commits with, and authenticate using a repository-scoped access token with limited access rights.

Check if a deployment has a user assigned to it

  1. Select an existing, or start creating a new deployment
  2. Scroll down to the “Git” section
  3. If the assigned user card is showing “Empty”, no user is assigned to the deployment. Otherwise, the user shown is the one assigned to the deployment.

Assign yourself to a deployment

  1. Select an existing, or start creating a new deployment
  2. Scroll down to the “Git” section
  3. Click “Assign self”

Remove an assigned user from a deployment

  1. Select an existing deployment
  2. Scroll down to the “Git” section
  3. Click the “trash” icon on the assigned user card

Manual Authentication

When the Git “assigned user” field is left empty on a deployment, no automated Git configuration or authentication will happen. This means that you will have to do the first-time setup with Git yourself, and provide a way to authenticate.
We have collected the best ways this can be achieved below, altough letting Diploi handle it is recommended.

GitHub Personal Access Token (PAT)

SSH Agent Forwarding

GitHub Deploy Key