This project creates full-stack platform-specific downloadable packages for GitLab.
Go to file
GitLab Release Tools Bot f44a3ecc49 Update changelog for 16.8.7
[ci skip]
2024-04-12 22:00:39 +00:00
.gitlab Remove milestone requirement from security MR template 2023-11-29 16:10:09 -06:00
config Merge branch 'deps/69b928e-06f4868' into 'master' 2024-04-12 19:48:10 +00:00
danger Fix merge_request workflow page linked on the Danger comment 2023-11-16 13:57:00 +00:00
doc Add sslmode to instructions for replicate-geo-database 2024-04-02 15:18:22 +00:00
docker Auto upgrade single node installs to PostgreSQL 14 2024-03-25 08:55:22 +00:00
files Merge branch 'add-grpc-level-config-for-kas' into 'master' 2024-04-10 21:20:33 +00:00
gitlab-ci-config Pass DEV_BUILDER_IMAGE_REGISTRY variable to downstream pipeline 2024-04-09 15:28:45 +00:00
letsencrypt-test Add CI job to validate Let's Encrypt behavior against test ACME endpoint 2021-05-18 15:32:29 +00:00
lib Pass DEV_BUILDER_IMAGE_REGISTRY variable to downstream pipeline 2024-04-09 15:28:45 +00:00
resources/rpm Fix package signing for newer rpm versions 2019-07-05 09:54:43 +05:30
scripts Use gitlab-dangerfiles gem 2022-08-16 22:45:11 +00:00
spec Merge branch 'add-grpc-level-config-for-kas' into 'master' 2024-04-10 21:20:33 +00:00
support Update prometheus from 2.50.1 to 2.51.0 2024-03-27 20:41:04 +00:00
test-plans Bump rubygems to version 3.5.7 2024-04-11 03:34:02 +00:00
.custom_sources.yml Merge branch 'sh-use-gitlab-ruby-shadow' into 'master' 2024-02-14 04:29:11 +00:00
.gitattributes Update merge strategy for CHANGELOG.md 2018-03-26 11:27:04 +01:00
.gitignore Generate packer manifests and store them as artifacts 2022-11-30 01:03:10 +00:00
.gitlab-ci.yml Bump builder image to 5.10.0 2024-04-12 07:45:31 +00:00
.markdownlint-cli2.yaml Fully implement markdownlint-cli2 in project 2024-02-02 14:55:04 +10:00
.projections.json.example Restructure chef rspecs to match code structure 2022-03-24 04:38:17 +00:00
.rspec Unify the Rspec options into a single pattern 2022-06-03 07:42:02 +00:00
.rubocop.yml Add Rubocop cop to enforce default_version in software definitions 2024-04-08 16:29:41 +00:00
.rubocop_todo.yml Specify a dummy version for gitlab-backup-cli 2024-04-04 08:39:11 +00:00
.ruby-version Bump Ruby in .ruby-version file 2023-12-21 11:39:27 +05:30
.tool-versions Vale and Markdown rule refresh for project 2024-02-08 05:22:59 +00:00
.vale.ini Add Vale checks to project 2020-03-18 06:38:21 +00:00
.yardopts Add yard to generate Ruby code documentation 2021-08-24 04:44:29 +00:00
Berksfile Initial commit 2013-11-21 13:06:42 +02:00
CHANGELOG.md Update changelog for 16.8.7 2024-04-12 22:00:39 +00:00
CONTRIBUTING.md Fix broken links on CONTRIBUTING doc 2022-12-07 09:42:43 +00:00
Dangerfile Enable reviewer-roulette for MRs 2023-10-17 16:35:08 +00:00
GITALY_SERVER_VERSION Reset Gitaly server version back to master 2019-05-03 04:47:51 -07:00
GITLAB_ELASTICSEARCH_INDEXER_VERSION Update GITLAB_ELASTICSEARCH_INDEXER_VERSION to use main branch 2021-02-11 21:40:50 +00:00
GITLAB_KAS_VERSION Switch GITLAB_KAS_VERSION to master 2021-01-11 23:09:41 +00:00
GITLAB_PAGES_VERSION Move all VERSION files back to master 2019-05-03 05:08:42 -07:00
GITLAB_SHELL_VERSION Use the 'main' branch for gitlab-shell nightlies 2020-11-26 13:36:42 +00:00
GITLAB_WORKHORSE_VERSION Move all VERSION files back to master 2019-05-03 05:08:42 -07:00
Gemfile Update Cinc/Ohai to 18.x series 2024-01-25 10:09:14 -08:00
Gemfile.lock Bump Omnibus to 9.0.19.2 2024-03-05 15:45:18 +00:00
LICENSE Change docs license to CC BY-SA 4.0 2018-05-04 13:19:15 +02:00
OMNIBUS_GEM_VERSION Bump Omnibus to 9.0.19.2 2024-03-05 15:45:18 +00:00
README.md Fix some broken links in project README.md file 2023-12-08 12:11:20 +00:00
Rakefile Speed up rubocop CI job 2018-03-11 10:11:23 +09:00
VERSION Reset VERSION to say master 2019-04-21 11:30:31 +05:30
deps.yml Check correct file for openssl deps updates 2024-03-14 00:52:32 -04:00
omnibus.rb Bump omnibus to 8.2.1.6 2022-02-04 15:39:29 +00:00
omnibus.rb.example Initial commit 2013-11-21 13:06:42 +02:00

README.md

Omnibus GitLab

Description

This project creates full-stack platform-specific downloadable packages for GitLab. For other installation options please see the GitLab installation page.

Canonical source

The source of omnibus-gitlab is hosted on GitLab.com and there are mirrors to make contributing as easy as possible.

Documentation

The documentation can be found in the doc directory.

Omnibus fork

Omnibus GitLab is using a fork of omnibus project. For additional information see the comments in the Gemfile.

We left the links below in the readme to preserve old links, but please use the doc directory to browse the complete documentation.

Contributing

Please see the contribution guidelines

Installation

Please follow the steps on the downloads page.

After installation

Your GitLab instance should be reachable over HTTP at the IP or hostname of your server. You can login as an admin user with username root and password 5iveL!fe.

See doc/maintenance/index.md for useful commands to control/debug your GitLab instance.

Configuration options

See doc/settings/configuration.md.

Configuring the external URL for GitLab

See doc/settings/configuration.md.

Storing Git data in an alternative directory

See doc/settings/configuration.md.

Changing the name of the Git user / group

See doc/settings/configuration.md.

Setting up LDAP sign-in

See doc/settings/ldap.md.

Enable HTTPS

See doc/settings/nginx.md.

Redirect HTTP requests to HTTPS

See doc/settings/nginx.md.

Change the default port and the ssl certificate locations

See doc/settings/nginx.md.

Use non-packaged web-server

For using an existing Nginx, Passenger, or Apache webserver see doc/settings/nginx.md.

Using a non-packaged PostgreSQL database management server

To connect to an external PostgreSQL DBMS see doc/settings/database.md

Using a non-packaged Redis instance

See doc/settings/redis.md.

Adding ENV Vars to the Gitlab Runtime Environment

See doc/settings/environment-variables.md.

Changing gitlab.yml settings

See doc/settings/gitlab.yml.md.

Specify numeric user and group identifiers

See doc/settings/configuration.md.

Sending application email via SMTP

See doc/settings/smtp.md.

Omniauth (Google, Twitter, GitHub login)

Omniauth configuration is documented in docs.gitlab.com.

Adjusting Unicorn settings

See doc/settings/unicorn.md.

Setting the NGINX listen address or addresses

See doc/settings/nginx.md.

Inserting custom NGINX settings into the GitLab server block

See doc/settings/nginx.md.

Inserting custom settings into the NGINX config

See doc/settings/nginx.md.

Only start omnibus-gitlab services after a given filesystem is mounted

See doc/settings/configuration.md.

Updating

Instructions for updating your Omnibus installation and upgrading from a manual installation are in the update directory.

Uninstalling Omnibus GitLab

See doc/installation/index.md.

Common installation problems

This section has been moved to the separate document doc/troubleshooting.md.

Section below remains for historical reasons(mainly to not break existing links). Each section contains the link to the new location.

Apt error 'The requested URL returned error: 403'

See doc/troubleshooting.md.

GitLab is unreachable in my browser

See doc/troubleshooting.md.

Emails are not being delivered

See doc/troubleshooting.md.

TCP ports for GitLab services are already taken

See doc/troubleshooting.md.

Git SSH access stops working on SELinux-enabled systems

See doc/troubleshooting.md.

Postgres error 'FATAL: could not create shared memory segment: Cannot allocate memory'

See doc/troubleshooting.md.

Reconfigure complains about the GLIBC version

See doc/troubleshooting.md.

Reconfigure fails to create the git user

See doc/troubleshooting.md.

Failed to modify kernel parameters with sysctl

See doc/troubleshooting.md.

I am unable to install omnibus-gitlab without root access

See doc/troubleshooting.md.

gitlab-rake assets:precompile fails with 'Permission denied'

See doc/troubleshooting.md.

'Short read or OOM loading DB' error

See doc/troubleshooting.md.

Backups

See doc/settings/backups.md.

Backup and restore omnibus-gitlab configuration

See doc/settings/backups.md.

Creating an application backup

See doc/settings/backups.md.

Restoring an application backup

See restore documentation.

Backup and restore using non-packaged database

If you are using non-packaged database see documentation on using non-packaged database.

Upload backups to remote (cloud) storage

For details check backup documentation.

Invoking Rake tasks

See doc/maintenance/index.md.

Directory structure

Omnibus-gitlab uses four different directories.

  • /opt/gitlab holds application code for GitLab and its dependencies.
  • /var/opt/gitlab holds application data and configuration files that gitlab-ctl reconfigure writes to.
  • /etc/gitlab holds configuration files for omnibus-gitlab. These are the only files that you should ever have to edit manually.
  • /var/log/gitlab contains all log data generated by components of omnibus-gitlab.

Omnibus-gitlab and SELinux

Although omnibus-gitlab runs on systems that have SELinux enabled, it does not use SELinux confinement features:

  • omnibus-gitlab creates unconfined system users;
  • omnibus-gitlab services run in an unconfined context.

The correct operation of Git access via SSH depends on the labeling of /var/opt/gitlab/.ssh. If needed you can restore this labeling by running sudo gitlab-ctl reconfigure.

Depending on your platform, gitlab-ctl reconfigure will install SELinux modules required to make GitLab work. These modules are listed in files/gitlab-selinux/README.md.

NSA, if you're reading this, we'd really appreciate it if you could contribute back a SELinux profile for omnibus-gitlab :) Of course, if anyone else is reading this, you're welcome to contribute the SELinux profile too.

Logs

This section has been moved to separate document doc/settings/logs.md.

Tail logs in a console on the server

See doc/settings/logs.md.

Runit logs

See doc/settings/logs.md.

Logrotate

See doc/settings/logs.md.

UDP log shipping (GitLab Enterprise Edition only)

See doc/settings/logs.md

Create a user and database for GitLab

See doc/settings/database.md.

Configure omnibus-gitlab to connect to it

See doc/settings/database.md.

Seed the database (fresh installs only)

See doc/settings/database.md.

Building your own package

See the separate build documentation.

Running a custom GitLab version

It is not recommended to make changes to any of the files in /opt/gitlab after installing omnibus-gitlab: they will either conflict with or be overwritten by future updates. If you want to run a custom version of GitLab you can build your own package or use another installation method.

Acknowledgments

This omnibus installer project is based on the awesome work done by Chef in omnibus-chef-server.