Skip to main content

​
Overview

This guide covers how to add SYNQ’s public SSH key to self-hosted and other SSH-based Git providers, including:
  • Self-hosted Git (Gitea, Gogs, GitBucket, etc.)
  • Any other SSH-based Git provider
For GitHub, GitLab, Bitbucket, and Azure DevOps, see their dedicated setup guides:
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

  • Admin or appropriate access to configure SSH keys/deploy keys
  • Public SSH key from your SYNQ Git integration
  • Git provider accessible over the internet via SSH
⏱️ Estimated time: 10-15 minutes

​
Adding SSH Keys to Self-Hosted Git

The process for adding SSH keys to self-hosted Git instances varies by software, but generally follows this pattern:

​
General Setup Steps

  1. Navigate to your repository settings in your Git interface
  2. Look for one of these sections:
    • Deploy Keys (most common)
    • Access Keys
    • SSH Keys
  3. Click Add key or similar button
  4. Configure the key:
    • Title/Name: Enter a descriptive name (e.g., SYNQ Integration)
    • Key: Paste the complete public SSH key from SYNQ
    • Permissions: Select Read-only or equivalent
  5. Save the key
Always configure the key with read-only permissions. SYNQ never needs write access to your repository.

​
Common Self-Hosted Git Platforms

  1. Go to your repository in Gitea
  2. Click Settings > Deploy Keys
  3. Add the title and paste the public key
  4. Do not check “Grant Write Access”
  5. Click Add Deploy Key
For more details, see the Gitea Documentation.
  1. Navigate to your repository
  2. Go to Settings > Deploy Keys
  3. Enter a key name and paste the public key
  4. Click Add Deploy Key
Gogs Deploy Keys Documentation
  1. Open your repository settings
  2. Navigate to Deploy Keys
  3. Add the title and public key
  4. Set permission to Read Only
  5. Click Add
GitBucket Documentation
For other self-hosted Git software:
  1. Consult your Git software’s documentation for SSH key or deploy key configuration
  2. Look for repository-level SSH key settings (preferred over user-level keys)
  3. Ensure the key is configured with read-only access
  4. Test the connection from SYNQ after adding the key
Most Git software follows similar patterns to the examples above.

​
Requirements for Self-Hosted Git

Ensure your self-hosted Git instance meets these requirements:
  • Internet accessible: Must be reachable from SYNQ’s IP addresses
  • SSH enabled: SSH protocol must be enabled (typically port 22)
  • Firewall configured: Allow connections from SYNQ’s egress IPs
  • Valid SSL certificate: If using HTTPS for the web interface

​
IP Whitelisting (If Required)

If your Git provider uses IP whitelisting, add SYNQ’s egress IP addresses for your region. For self-hosted Git instances, configure your firewall to allow connections from these IP addresses. See SYNQ IP Whitelist for the complete list of IP addresses.

​
Troubleshooting

​
Deploy key/SSH key not working

  • Verify the complete public key was copied (including the ssh-rsa or ssh-ed25519 prefix)
  • Ensure the key was added to the correct repository or account
  • Confirm the key has read-only permissions

​
Connection refused

  • Check that IP whitelisting (if configured) includes SYNQ’s egress IPs
  • Verify the repository SSH URL is correct in SYNQ’s integration form
  • For self-hosted Git, ensure the instance is accessible from SYNQ’s IP addresses

​
Self-hosted Git issues

  • Confirm your Git instance is accessible over the internet
  • Verify firewall rules allow connections from SYNQ’s IPs
  • Check that SSH is enabled and listening on the expected port (usually 22)
  • Test SSH connectivity: ssh -T [email protected]

​
Additional Resources

​
Need Help?

If you’re having trouble connecting your Git provider, contact SYNQ support with:
  • Your Git provider type (Bitbucket, Azure DevOps, self-hosted, etc.)
  • The SSH URL format you’re using
  • Any error messages from the connection attempt