Insites Docs Instance IntegrationsGit RepositoryConfiguring a GitHub Repository with an Instance

Configuring a GitHub Repository with an Instance

Last updated on December 02, 2025.

Setting up a Git repository with an Insites Instance consists of the following tasks:

  • Task 1: Key Generation
  • Task 2: Key Registration
  • Task 3: Instance Configuration

Task 1: Key Generation

A unique SSH key pair must be generated. Since this key will be used by an automated system (the Insites Instance), it must not be protected by a passphrase.

  1. Create an SSH key. For security and separation, this key pair should be generated on a secure machine or by a trusted operations tool, as the Private Key will be handled and stored in LastPass.
  2. Do not set a passphrase when prompted.
  3. Securely store the keys.
    • Store the SSH Private Key (the secret file, e.g., TAG id_rsa) in a designated entry in LastPass.
    • Store the SSH Public Key (the file ending in TAG .pub) temporarily, as it is needed for Task 2.

Task 2: Key Registration

You need to register the Public Key with your GitHub repository to grant the Instance access.

  1. Navigate to GitHub Repository Settings:
    • Go to your target GitHub repository's main page.
    • Navigate to the 'Settings' tab.
  2. Access Deploy Keys:
    • In the left sidebar menu, select Deploy keys.
    • Select Add deploy key.
  3. Install the Public Key:
    • Title: Enter a descriptive title (e.g., 'Insites Instance Deploy Key').
    • Key: Paste the SSH Public Key (the contents of the TAG .pub file) from Task 1 into this field.
    • Allow write access: Leave this unchecked unless your Instance needs to push changes back to the repository (e.g., version tagging).
    • Select Add key.
  4. After adding the key, GitHub displays its unique short identifier (the SSH Key ID) or a Key Fingerprint (SHA hash). Copy this value, as it is required for Task 3.
Important

SSH Key ID and SSH Private Keys must be available in LastPass.

Task 3: Instance Configuration

Then, configure GitHub on your Instance using the following steps:

  1. Navigate to Integrations from the main menu.
  2. Select Version Control.
  3. Select ADD REPOSITORY CREDENTIALS.
  4. Fill out the form for adding repository credentials.
  5. Select SAVE.

The input requirements for adding repository credentials to your Instance are displayed below:

FieldTypeRequiredActions
Enable Version Control Toggle No Enable toggle to use Version Control for the Instance.
SSH Repository URL Input Field Yes

The full repository address used to connect to your Version Control System (VCS). This URL tells the system where to pull the application code from.

To retrieve the SSH Repository URL:

  1. Log in to your GitHub account.
  2. Select the green < > Code button.
  3. Navigate to the 'SSH' tab.
  4. Copy your GitHub repository's SSH key.
  5. Paste your GitHub repository's SSH key into the 'SSH Repository URL' field.
SSH Key ID Input Field Yes

The Key ID or SHA Fingerprint retrieved from GitHub in Task 2, Step 4.
SSH Private Key Code Area Yes

The secret key used to authenticate your Instance with the Git repository securely. This key must be kept absolutely private and should correspond to the public key registered with your VCS host (e.g., GitHub).

To retrieve the SSH Private Key:

  1. Login to your Lastpass account
  2. Retrieve the SSH Private Key you saved from when you created the SSH key
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.