gitlab
/
omnibus-gitlab
mirror of https://gitlab.com/gitlab-org/omnibus-gitlab.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
This project creates full-stack platform-specific downloadable packages for GitLab.
10,793 Commits 1,205 Branches 4,516 Tags 56 MiB
Ruby 87.1%
HTML 10.9%
Shell 1.2%
HCL 0.7%
Go to file
Evan Read 9a73f9fbb2 Add Vale checks to project 
- Adds error-only configution.
- Makes check part of CI pipeline.
- Fixes errors in content.
 		2020-03-18 06:38:21 +00:00
.gitlab Updates security issue and mr templates 2020-03-13 14:26:49 +00:00
changelogs/unreleased Merge branch 'cat-geo-secondary-2phase-restart-5159' into 'master' 2020-03-16 21:50:49 +00:00
ci_build_specs Switch to using gitlab-styles for rubocop 2019-07-31 14:18:19 -07:00
config Bump Container Registry to v2.8.2-gitlab 2020-03-16 05:31:48 +00:00
doc Add Vale checks to project 2020-03-18 06:38:21 +00:00
docker Run grafana reset in docker container 2019-08-14 22:05:02 +05:30
files Merge branch 'cat-geo-secondary-2phase-restart-5159' into 'master' 2020-03-16 21:50:49 +00:00
gitlab-ci-config Add Vale checks to project 2020-03-18 06:38:21 +00:00
lib Skip upload of scientific 8 and os 8 packages 2020-03-05 16:42:46 -08:00
resources/rpm Fix package signing for newer rpm versions 2019-07-05 09:54:43 +05:30
scripts Revert security harness check to let devs push to dev.gitlab.org 2020-03-17 20:04:34 +05:30
spec Merge branch 'cat-geo-secondary-2phase-restart-5159' into 'master' 2020-03-16 21:50:49 +00:00
support Attempt to expand license file variable only if it exists 2020-02-21 13:35:28 +05:30
.custom_sources.yml Update the openssl software with upstream changes 2019-12-31 15:47:51 -08:00
.cveignore Use the updated gitlab-depscan tool that allows whitelisting CVEs 2020-02-21 23:15:30 +00:00
.gitattributes Update merge strategy for CHANGELOG.md 2018-03-26 11:27:04 +01:00
.gitignore Ignore simple.rb file in project directory 2019-07-05 15:10:21 +05:30
.gitlab-ci.yml Bumb max package size to 850 2020-02-15 08:27:54 -08:00
.markdownlint.json Align markdownlint config to main repo version 2019-12-11 05:52:48 +00:00
.rspec Introduce a Build::Image module and reorganize its subclasses and Rake tasks 2017-12-07 15:19:50 +01:00
.rubocop.yml Update security-harness for Security remote 2019-12-16 10:43:06 -06:00
.rubocop_todo.yml Update the todo list with the current gitlab-styles changes 2019-07-31 14:27:15 -07:00
.ruby-version Specify Ruby version as 2.6.3 for development 2019-06-12 17:17:17 +05:30
.vale.ini Add Vale checks to project 2020-03-18 06:38:21 +00:00
Berksfile Initial commit 2013-11-21 13:06:42 +02:00
CHANGELOG.md Update CHANGELOG.md for 12.8.7+ce.0 2020-03-16 19:16:12 +00:00
CONTRIBUTING.md Replace references of gitlab-org/gitlab-ce to gitlab-org/gitlab-foss 2019-09-13 19:56:12 +05:30
Dangerfile Reformat output to be one entry 2019-09-06 17:58:39 +00:00
GITALY_SERVER_VERSION Reset Gitaly server version back to master 2019-05-03 04:47:51 -07:00
GITLAB_ELASTICSEARCH_INDEXER_VERSION Use master as the default gitlab-elasticsearch-indexer version 2019-10-15 16:58:53 +01:00
GITLAB_PAGES_VERSION Move all VERSION files back to master 2019-05-03 05:08:42 -07:00
GITLAB_SHELL_VERSION Move all VERSION files back to master 2019-05-03 05:08:42 -07:00
GITLAB_WORKHORSE_VERSION Move all VERSION files back to master 2019-05-03 05:08:42 -07:00
Gemfile Add rspec-parameterized for table based tests 2020-01-13 15:49:26 +01:00
Gemfile.lock Add rspec-parameterized for table based tests 2020-01-13 15:49:26 +01:00
LICENSE Change docs license to CC BY-SA 4.0 2018-05-04 13:19:15 +02:00
README.md Modernize remove commands for uninstall 2020-01-28 13:28:21 +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 Add changelog 2020-03-09 13:46:17 -07:00
omnibus.rb Drop the env util changes 2019-07-31 17:03:14 -07: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 overview is in the readme in the doc directory.

Omnibus fork

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

Deprecated links

We left the links below in the readme to preserve old links, but please use the readme in 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/README.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 doc.

Uninstalling omnibus-gitlab

To remove all users and groups created by omnibus-gitlab, before removing the gitlab package (with dpkg or yum) run sudo gitlab-ctl remove-accounts. Note All gitlab processes need to be stopped before running the command.

To remove all omnibus-gitlab data use sudo gitlab-ctl cleanse.

To uninstall omnibus-gitlab, preserving your data (repositories, database, configuration), run the following commands.

# Stop gitlab and remove its supervision process
sudo systemctl stop    gitlab-runsvdir
sudo systemctl disable gitlab-runsvdir
sudo rm /usr/lib/systemd/system/gitlab-runsvdir.service
sudo systemctl daemon-reload
sudo gitlab-ctl uninstall

# (Replace with gitlab-ce if you have GitLab FOSS installed)

# Debian/Ubuntu
sudo apt remove gitlab-ee

# Redhat/Centos
sudo yum remove gitlab-ee

Common installation problems

This section has been moved to the separate document doc/common_installation_problems/README.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/common_installation_problems/README.md.

GitLab is unreachable in my browser

See doc/common_installation_problems/README.md.

Emails are not being delivered

See doc/common_installation_problems/README.md.

Reconfigure freezes at ruby_block[supervise_redis_sleep] action run

See doc/common_installation_problems/README.md.

TCP ports for GitLab services are already taken

See doc/common_installation_problems/README.md.

Git SSH access stops working on SELinux-enabled systems

See doc/common_installation_problems/README.md.

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

See doc/common_installation_problems/README.md.

Reconfigure complains about the GLIBC version

See doc/common_installation_problems/README.md.

Reconfigure fails to create the git user

See doc/common_installation_problems/README.md.

Failed to modify kernel parameters with sysctl

See doc/common_installation_problems/README.md.

I am unable to install omnibus-gitlab without root access

See doc/common_installation_problems/README.md.

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

See doc/common_installation_problems/README.md.

'Short read or OOM loading DB' error

See doc/common_installation_problems/README.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 backup 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 restore document of GitLab CE.

Invoking Rake tasks

See doc/maintenance/README.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.