Skip to main content

​
Overview

This guide covers how to add SYNQ’s public SSH key as a deploy key to your GitLab project.
Before you start: Create your Git integration in SYNQ first by following the integration form instructions. You’ll need the public SSH key from that integration.

​
Prerequisites

  • Access to GitLab (GitLab.com or self-managed instance)
  • Maintainer or Owner access to your project (required to add deploy keys)
  • Public SSH key from your SYNQ Git integration
⏱️ Estimated time: 5 minutes

​
IP Whitelisting (If Required)

If your GitLab group uses IP address restrictions, add SYNQ’s egress IP addresses for your region. See SYNQ IP Whitelist for the complete list. For instructions on configuring IP restrictions in GitLab, see GitLab’s guide on IP address restrictions.

​
Adding the Deploy Key

Follow these steps to add the SYNQ public key as a deploy key to your GitLab project.
  1. On the top bar, select Menu > Projects and find your project
  2. On the left sidebar, select Settings > Repository
    If you don’t see the Settings menu, you likely don’t have Maintainer or Owner access to the project. Contact your project administrator to add the deploy key.

​
Add the Deploy Key

  1. Expand Deploy keys
  2. Configure the deploy key:
    • Title: Enter a descriptive name (e.g., SYNQ Integration)
    • Key: Paste the public key that SYNQ provided in Step 1
    • Grant write permissions to this key: Leave this checkbox unticked (unchecked)
Do not grant write permissions. SYNQ only requires read-only access to your repository.
  1. Click Add key to save the deploy key
The deploy key is enabled immediately upon creation. SYNQ can now access your GitLab project in read-only mode.

​
Troubleshooting

​
Deploy key not working

  • Verify the complete public key was copied (including the ssh-rsa or ssh-ed25519 prefix)
  • Ensure the deploy key was added to the correct project
  • Confirm write permissions are disabled (unchecked)

​
Connection refused

  • Check that your GitLab group’s IP address restrictions (if configured) include SYNQ’s egress IPs
  • Verify the repository SSH URL is correct in SYNQ’s integration form
  • For self-managed GitLab, ensure the instance is accessible from SYNQ’s IP addresses

​
No Settings menu visible

  • Confirm you have Maintainer or Owner access to the project
  • Check with your GitLab administrator for access permissions

​
Additional Resources