Administrator Docs (CORE ONLY)

Learn how to administer your self-managed GitLab instance.

GitLab has two product distributions available through different subscriptions:

You can install either GitLab CE or GitLab EE. However, the features you'll have access to depend on the subscription you choose (Core, Starter, Premium, or Ultimate).

NOTE: Note: GitLab Community Edition installations only have access to Core features. is administered by GitLab, Inc., therefore, only GitLab team members have access to its admin configurations. If you're a user, please check the user documentation.

NOTE: Note: Non-administrator users don’t have access to GitLab administration tools and settings.

Installing and maintaining GitLab

Learn how to install, configure, update, and maintain your GitLab instance.

Installing GitLab

  • Install: Requirements, directory structures, and installation methods.
  • High Availability: Configure multiple servers for scaling or high availability.
  • Geo: Replicate your GitLab instance to other geographic locations as a read-only fully operational version. (PREMIUM ONLY)
  • Disaster Recovery: Quickly fail-over to a different site with minimal effort in a disaster situation. (PREMIUM ONLY)
  • Pivotal Tile: Deploy GitLab as a pre-configured appliance using Ops Manager (BOSH) for Pivotal Cloud Foundry. (PREMIUM ONLY)
  • Add License: Upload a license at install time to unlock features that are in paid tiers of GitLab. (STARTER ONLY)

Configuring GitLab

Customizing GitLab's appearance

  • Header logo: Change the logo on all pages and email headers.
  • Favicon: Change the default favicon to your own logo.
  • Branded login page: Customize the login page with your own logo, title, and description.
  • "New Project" page: Customize the text to be displayed on the page that opens whenever your users create a new project.
  • Additional custom email text: Add additional custom text to emails sent from GitLab. (PREMIUM ONLY)

Maintaining GitLab

  • Raketasks: Perform various tasks for maintenance, backups, automatic webhooks setup, etc.
  • Operations: Keeping GitLab up and running (clean up Redis sessions, moving repositories, Sidekiq MemoryKiller, Unicorn).
  • Restart GitLab: Learn how to restart GitLab and its components.
  • Invalidate Markdown cache: Invalidate any cached Markdown.

Updating GitLab

Upgrading or downgrading GitLab

GitLab platform integrations

  • Mattermost: Integrate with Mattermost, an open source, private cloud workplace for web messaging.
  • PlantUML: Create simple diagrams in AsciiDoc and Markdown documents created in snippets, wikis, and repos.
  • Web terminals: Provide terminal access to your applications deployed to Kubernetes from within GitLab's CI/CD environments.

User settings and permissions

Project settings

Package Registry administration

  • Container Registry: Configure Container Registry with GitLab.
  • Package Registry: Enable GitLab to act as an NPM Registry and a Maven Repository. (PREMIUM ONLY)
  • Dependency Proxy: Configure the Dependency Proxy, a local proxy for frequently used upstream images/packages. (PREMIUM ONLY)

Repository settings

Continuous Integration settings

Snippet settings

Git configuration options

Monitoring GitLab

Performance Monitoring


  • Pseudonymizer: Export data from GitLab's database to CSV files in a secure way. (ULTIMATE)


Support Team Docs

The GitLab Support Team has collected a lot of information about troubleshooting GitLab instances. These documents are normally used by the Support Team itself, or by customers with direct guidance from a Support Team member. GitLab administrators may find the information useful for troubleshooting, but if you are experiencing trouble with your GitLab instance, you should check your support options before referring to these documents.

CAUTION: Warning: Using the commands listed in the documentation below could result in data loss or other damage to a GitLab instance, and should only be used by experienced administrators who are aware of the risks.