GitLab Enterprise Sync

Connect ReadMe to GitLab to keep your documentation in sync with your codebase. GitLab connection works the same way across GitLab plan types. There is no separate GitLab Enterprise configuration required.

This guide walks through repository requirements, access token setup, and has links to connect GitLab to ReadMe.

Connect GitLab to ReadMe

Enterprise GitLab setup follows the same flow as the standard connector.

Go to GitLab Sync for a setup guide.

Repository Requirements

Each child project can only sync to one repository, and that repository must be completely empty before connecting. You can add and remove files after setup is complete.

GitLab does not require a separate Enterprise Server configuration. The standard GitLab connector supports GitLab.com across Free, Premium, and Ultimate plans, as well as self-managed GitLab instances accessible
from the internet.

ReadMe Permission Requirements

ReadMe requires a personal access token with the api scope. If you prefer a project access token, note that the Maintainer role is required, and GitLab can limit the number of project access tokens.

ReadMe requests access to:

• read_api for listing projects
• read_user and read_profile to display user information
• read_repository to sync content in GitLab to ReadMe
• write_repository to sync content in ReadMe to GitLab

Self-Managed GitLab Instances

If your GitLab instance is behind a VPN or firewall, ensure it is reachable from the internet, or allowlist ReadMe's outbound IP addresses. You can find these under Settings > Git Connection in your ReadMe dashboard, or on the
Outbound IP Addresses page.