• Package information
• Installation
• Running on a low-resource device (like a Raspberry Pi)
• Maintenance
• Configuring
• Upgrading
• Troubleshooting
• Omnibus GitLab developer documentation

Omnibus GitLab Documentation

Omnibus GitLab is a way to package different services and tools required to run GitLab, so that most users can install it without laborious configuration.

Package information

• Checking the versions of bundled software
• Package defaults
• Components included
• Deprecated Operating Systems
• Signed Packages
• Deprecation Policy
• Licenses of bundled dependencies

Installation

For installation details, see Installing Omnibus GitLab.

Running on a low-resource device (like a Raspberry Pi)

You can run GitLab on supported low-resource computers like the Raspberry Pi 3, but you must tune the settings to work best with the available resources. Check out the documentation for suggestions on what to adjust.

Maintenance

• Get service status
• Starting and stopping
• Invoking Rake tasks
• Starting a Rails console session
• Starting a PostgreSQL superuser psql session
• Container registry garbage collection

Configuring

• Configuring the external URL
• Configuring a relative URL for GitLab (experimental)
• Storing Git data in an alternative directory
• Changing the name of the Git user group
• Specify numeric user and group identifiers
• Only start Omnibus GitLab services after a given file system is mounted
• Disable user and group account management
• Disable storage directory management
• Failed authentication ban
• SMTP
• NGINX
• LDAP
• Puma
• ActionCable
• Redis
• Logs
• Database
• Reply by email
• Environment variables
• gitlab.yml
• Backups
• Pages
• SSL
• GitLab and Registry
• Configuring an asset proxy server
• Image scaling

Upgrading

• Upgrade guidance, including supported upgrade paths.
• Upgrade from Community Edition to Enterprise Edition
• Upgrade to the latest version
• Downgrade to an earlier version
• Upgrade from a non-Omnibus installation to an Omnibus installation using a backup
• Upgrade from non-Omnibus PostgreSQL to an Omnibus installation in-place
• Upgrade from non-Omnibus MySQL to an Omnibus installation (version 6.8+)

Troubleshooting

For troubleshooting details, see Troubleshooting Omnibus GitLab installation issues.

Omnibus GitLab developer documentation

See the development documentation