Configure Git

Ensure that .preferences.yaml is added to your repo’s .gitignore file so that your Git settings aren’t pushed to Github.

Navigate to the Wizard icon in the top right, then select Settings to open your Mage settings.

There should be an option for Git settings on the left side of the settings modal.

Change the authentication type to SSH. The interface will change for you to input a remote repo url.

If you haven’t already, configure your SSH key— this will allow your instance to access GitHub. Our instructions can help if you’re unfamiliar with the process.

• Remote repo url: Your Github repository’s remote url. Use the SSH link instead of HTTPS link.
• Local directory path: The directory in your machine that will be synced with the Github repository. If this field is omitted, it will default to the path determined by Python’s os.getcwd(). You can check what your current working directory is in a Scratchpad block.

If using Git Sync, tic the box labeled "use One-way Git Sync". You can read more about Git Sync here. If One-way Git Sync is enabled, you'll also need to provide:

• Branch Name: The name of the branch you want to sync with.
• Include submodules: If your repo has submodules, tic this box to include them in the sync.
• Sync before each trigger run: If you'd like a sync to occur before a trigger run to ensure that the latest code is used, tic this box.
• Sync on server start up: If you'd like to sync on server start up, tic this box.

Otherwise, continue to the next step.

Filling out these fields will allow Mage to recreate your git and SSH settings if they are deleted (i.e. if your container restarts):

• Username: Your git username. If you push to your remote repo, this username will show up next to your commits.
• Email: Your git email. Used for the same purpose as your username.
• SSH public key in base64, SSH public key in base64: Enter your SSH public and private key encoded in base64. You can follow the instructions in the field description if you want to Mage to save your SSH keys.

Click “Save repository settings” to complete the setup.

Ensure that .preferences.yaml is added to your repo’s .gitignore file so that your Git settings aren’t pushed to Github.

Navigate to the Wizard icon in the top right, then select Settings to open your Mage settings.

There should be an option for Git settings on the left side of the settings modal.

• GitHub
• GitLab

• Remote repo url: Your Github repository’s remote url. Use the SSH link instead of HTTPS link.
• Local directory path: The directory in your machine that will be synced with the Github repository. If this field is omitted, it will default to the path determined by Python’s os.getcwd(). You can check what your current working directory is in a Scratchpad block.

If using Git Sync, tic the box labeled "use One-way Git Sync". You can read more about Git Sync here. If One-way Git Sync is enabled, you'll also need to provide:

• Branch Name: The name of the branch you want to sync with.
• Include submodules: If your repo has submodules, tic this box to include them in the sync.
• Sync before each trigger run: If you'd like a sync to occur before a trigger run to ensure that the latest code is used, tic this box.
• Sync on server start up: If you'd like to sync on server start up, tic this box.

Otherwise, continue to the next step.

• Username: Your git username. If you push to your remote repo, this username will show up next to your commits.
• Email: Your git email. Used for the same purpose as your username.
• Access token: Enter the Git access token that you created in step 4.

Click “Save repository settings” to complete the setup.

Follow GitHub’s guide here to check for an existing SSH key.

If no key exists, generate a new key using this guide.

You may skip this step if you already have a key.

This step allows your Git provider to recognize your SSH key and communicate.

• GitHub Docs
• GitLab Docs

• GitHub Docs
• GitLab Docs

The first time you connect using your Git provider, you’ll get a message about verifying authenticity and adding the provider to your known hosts. For example:

The authenticity of host 'gitlab.example.com (35.231.145.151)' can't be established.
ECDSA key fingerprint is SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'gitlab.example.com' (ECDSA) to the list of known hosts.

This is normal and expected. Type yes and press enter to continue.