Difference between revisions of "Gitlab"

From ArchWiki
Jump to: navigation, search
(merge request)
(Errors after updating: updated command to recompile assets)
 
(407 intermediate revisions by 68 users not shown)
Line 1: Line 1:
 
[[Category:Version Control System]]
 
[[Category:Version Control System]]
{{Article summary start}}
+
[[ja:Gitlab]]
{{Article summary text|This page gives guidelines for the installation and configuration of Gitlab on Archlinux.}}
+
{{Related articles start}}
{{Article summary heading|Related}}
+
{{Related|Gitolite}}
{{Article summary wiki|Gitolite}}
+
{{Related|Ruby on Rails}}
{{Article summary wiki|Ruby on Rails}}
+
{{Related articles end}}
{{Article summary end}}
 
{{Merge|Gitlab2|Most of the article is duplicated.}}
 
{{Out of date|As of version 5.0,Gitlab will no longer depend on gitolite. Also redis is replaced by sidekiq. A rewrite is scheduled when 5.0 comes out on March 22nd.}}
 
  
[http://gitlabhq.com/ Gitlab] is a free git repository management application based on [[Ruby on Rails]] and [[Gitolite]]. It is distributed under the MIT License and its source code can be found on [https://github.com/gitlabhq/gitlabhq Github]. It is a very active project with a monthly release cycle and ideal for businesses that want to keep their code private. Consider it as a self hosted Github but open source. You can try a demo page [http://gitlabhq.com/ here].
+
From [https://about.gitlab.com/ GitLab's homepage:]
  
{{Note|Throughout the article, sudo is heavily used, assuming that the user that is running the commands is root or someone with equal privileges. There is no need to edit the sudoers file whatsoever. It is only used to change to the appropriate user. For more info read {{ic|man sudo}}.}}
+
:GitLab offers git repository management, code reviews, issue tracking, activity feeds and wikis. Enterprises install GitLab on-premise and connect it with LDAP and Active Directory servers for secure authentication and authorization. A single GitLab server can handle more than 25,000 users but it is also possible to create a high availability setup with multiple active servers.
  
==Required packages==
+
An example live version can be found at [https://gitlab.com/ GitLab.com].
  
Install the packages below as they are needed to proceed further.
+
== Installation ==
 +
{{Note|If you want to use RVM refer to the article [[#Running GitLab with rvm]] before starting with the installation}}
  
# pacman -Syu --needed sudo git wget curl checkinstall libxml2 libxslt mysql++ base-devel zlib icu redis openssh python2 python2-pygments python2-pip libyaml ruby libpqxx
+
{{Note|This article covers installing and configuring GitLab without HTTPS at first. If needed, see [[#Advanced Configuration]] to set up SSL}}
  
==Create user accounts==
+
GitLab requires [[Redis]] and a database backend. If you plan to run it on the same machine, first install either [[MySQL]] or [[PostgreSQL]].
  
Add {{ic|git}} and {{ic|gitlab}} user. {{ic|git}} is a system user that will be used for [[gitolite]]. {{ic|gitlab}} user will be used for Gitlab and is part of group git.
+
[[Install]] the {{pkg|gitlab}} package.
  
# usermod -d /home/git git
+
In order to receive mail notifications, a mail server must be installed and configured. See the following for more information: [[:Category:Mail server]]
# mkdir -pv /home/git
 
# chown -R git:git /home/git
 
# useradd --user-group --shell /bin/bash --comment 'gitlab system' --create-home --groups git gitlab
 
  
Note that the user ''git'' must have its initial group set to ''git'' (not ''users''). If the initial group is not ''git'', then all files created by the ''git'' user will be owned by git:users which will prevent gitlab from showing you a newly created repo (it will get stucked at the page where it tells you how to push to the new repo). Running ''sudo usermod -g git git'' will set the ''git'' user's initial group.
+
== Configuration ==
  
==Gitolite==
+
=== Notes Before Configuring ===
 +
The {{pkg|gitlab}} package installs GitLab's files in a manner that more closely follows standard Linux conventions:
  
 +
{| class="wikitable"
 +
! Description
 +
! [https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md GitLab's Official]
 +
! {{pkg|gitlab}}
 +
|----------------------------------------------------------
 +
| Configuration File GitShell
 +
| {{ic|/home/git/gitlab-shell/config.yml}}
 +
| {{ic|/etc/webapps/gitlab-shell/config.yml}}
 +
|----------------------------------------------------------
 +
| Configuration File GitLab
 +
| {{ic|/home/git/gitlab/config/gitlab.yml}}
 +
| {{ic|/etc/webapps/gitlab/gitlab.yml}}
 +
|----------------------------------------------------------
 +
| User (Home Directory)
 +
| {{ic|git}} ({{ic|/home/git}})
 +
| {{ic|gitlab}} ({{ic|/var/lib/gitlab}})
 +
|}
  
Clone the gitolite repository from Gitlab's fork. Note that it's version 3.
+
{{tip|If you are familiar with the [[Arch Build System]] you can edit the PKGBUILD and relevant files to change gitlab's home directory to a place of your liking.}}
# cd /home/git
 
# sudo -H -u git git clone -b gl-v304 https://github.com/gitlabhq/gitolite.git /home/git/gitolite
 
  
Generate Gitlab's ssh key to be used with gitolite:
+
===Basic configuration===
  
{{ic|<nowiki> # sudo -H -u gitlab ssh-keygen -q -N '' -t rsa -f /home/gitlab/.ssh/id_rsa</nowiki>}}
+
====GitLab====
 +
Edit {{ic|/etc/webapps/gitlab/gitlab.yml}} and setup at least the following parameters:
  
Add the following path to git's {{ic|.bash_profile}}:
+
{{Tip|The hostname and port are used for the {{ic|git clone http://hostname:port}} as example.}}
# sudo -u git sh -c 'echo "export PATH=/home/git/bin:$PATH" >> /home/git/.bash_profile'
 
# sudo -u git sh -c 'mkdir /home/git/bin'
 
# sudo -u git -H sh -c "export PATH=/home/git/bin:$PATH; /home/git/gitolite/install -ln"
 
 
Copy Gitlab's public key to gitolite's home and change permissions:
 
# cp /home/gitlab/.ssh/id_rsa.pub /home/git/gitlab.pub
 
# chmod 0444 /home/git/gitlab.pub
 
  
Install gitolite:
+
'''Hostname:''' In the {{ic|gitlab:}} section set {{ic|host:}} - replacing {{ic|localhost}} to {{ic|yourdomain.com}} ('''note:''' no 'http://' or trailing slash) - into your fully qualified domain name.
# sudo -u git -H sh -c "export PATH=/home/git/bin:$PATH; /home/git/gitolite/src/gitolite setup -pk /home/git/gitlab.pub"
 
  
{{hc|Example output|
+
'''Port:''' {{ic|port:}} can be confusing. This is not the port that the gitlab server (unicorn) runs on; it's the port that users will initially access through in their browser. Basically, if you intend for users to visit 'yourdomain.com' in their browser, without appending a port number to the domain name, leave {{ic|port:}} as {{ic|80}}. If you intend your users to type something like 'yourdomain.com:3425' into their browsers, then you'd set {{ic|port:}} to {{ic|3425}}. You will also have to '''configure your webserver''' to listen on that port.
creating gitolite-admin...
+
 
Initialized empty Git repository in /home/git/repositories/gitolite-admin.git/
+
'''Timezone (optional):''' The {{ic|time_zone:}} parameter is optional, but may be useful to force the zone of GitLab applications.
creating testing...
+
 
Initialized empty Git repository in /home/git/repositories/testing.git/
+
Finally set the correct permissions to the ''uploads'' directory:
[master (root-commit) 012fdf5] start
 
2 files changed, 6 insertions(+)
 
create mode 100644 conf/gitolite.conf
 
create mode 100644 keydir/gitlab.pub
 
}}
 
  
Change permissions:
+
  # chmod 700 /var/lib/gitlab/uploads
  # chmod -R g+rwX /home/git/repositories/
 
# chmod g+x /home/git
 
# chown -R git:git /home/git/repositories/
 
  
{{Note| The next step is '''important''' to succeed. If not, do not try to proceed any further.}}
+
====GitLab Shell====
{{Note| If you obtain an error like "Permission denied (publickey)" for the next command, one reason can be that "UsePAM" is not activated in ssh. Set "UsePAM yes" in /etc/ssh/sshd_config" and restart the ssh server. }}
+
{{Out of date|Configuration variables in this section are no longer in config.yml}}
 +
{{Note|You can leave the {{ic|gitlab_url}} with default value if you intend to host GitLab on the same host.}}  
  
Add Gitlab's ssh key to known hosts:
+
Edit {{ic|/etc/webapps/gitlab-shell/config.yml}} and set {{ic|gitlab_url:}} to the prefer url and port:
# sudo -u gitlab -H git clone git@localhost:gitolite-admin.git /tmp/gitolite-admin
+
{{hc|/etc/webapps/gitlab-shell/config.yml|2=
 +
# GitLab user. git by default
 +
user: gitlab
  
Answer yes. At this point you should be able to clone the gitolite-admin repository.  
+
# Url to gitlab instance. Used for api calls. Should end with a slash.
 +
# Default: http://localhost:8080/
 +
# You only have to change the default if you have configured Unicorn
 +
# to listen on a custom port, or if you have configured Unicorn to
 +
# only listen on a Unix domain socket.
 +
gitlab_url: "http://localhost:8080/" #
  
{{hc|Example output|
+
http_settings:
Cloning into '/tmp/gitolite-admin'...
+
#  user: someone
The authenticity of host 'localhost (::1)' can't be established.
+
#  password: somepass
ECDSA key fingerprint is 5a:50:69:47:1f:1c:61:79:08:a8:2c:fa:a1:fb:48:bf.
+
...
Are you sure you want to continue connecting (yes/no)? yes
 
Warning: Permanently added 'localhost' (ECDSA) to the list of known hosts.
 
remote: Counting objects: 6, done.
 
remote: Compressing objects: 100% (4/4), done.
 
Receiving objects: 100% (6/6), 712 bytes, done.
 
remote: Total 6 (delta 0), reused 0 (delta 0)
 
 
}}
 
}}
  
If the repository is cloned successfully, it is safe to remove it:
+
Update the {{ic|/etc/webapps/gitlab/unicorn.rb}} configuration if the port and/or hostname is different from the default:
# rm -rf /tmp/gitolite-admin
+
{{hc|/etc/webapps/gitlab/unicorn.rb|2=
 +
listen "/run/gitlab/gitlab.socket", :backlog => 1024
 +
listen "'''127.0.0.1:8080'''", :tcp_nopush => true
 +
}}
  
==Gitlab==
+
====Redis====
 +
Using a [[Redis]] setup different from default (e.g. different address, port, unix socket) requires the environment variable ''REDIS_URL'' to be set accordingly for unicorn. This can be achieved by extending the systemd service file. Create a file ''/etc/systemd/system/gitlab-unicorn.service.d/redis.conf'' that injects the ''REDIS_URL'' environment variable:
 +
[Service]
 +
Environment=REDIS_URL=unix:///run/gitlab/redis.sock
  
===Installation===
+
=====Enable listen on socket=====
  
{{Tip| If you do not want to download any documentation, add {{ic|gem: --no-rdoc --no-ri}} to {{ic|/home/gitlab/.gemrc}}. Be sure to add it as the gitlab user in order to acquire the appropriate permissions.}}
+
Follow instructions describe on [[Redis#Listen on socket]], and adjust the default configuration [https://github.com/gitlabhq/gitlabhq/issues/6100].
  
Add [[ruby]] to Gitlab's {{ic|PATH}}:
+
* Add the user ''git'' and ''gitlab'' to the ''redis'' [[group]].
# sudo -u gitlab -H sh -c 'echo "export PATH=$(ruby -rubygems -e "puts Gem.user_dir")/bin:$PATH" >> /home/gitlab/.bashrc'
 
  
Install bundler and charlock_holmes:
+
* Update the configuration files:
# sudo -u gitlab -H gem install charlock_holmes --version '0.6.9'
+
{{hc|/etc/webapps/gitlab/resque.yml|2=
# sudo -u gitlab -H gem install bundler
+
development: unix:/var/run/redis/redis.sock
 +
test: unix:/run/redis/redis.sock
 +
production: unix:/run/redis/redis.sock
 +
}}
  
{{Note|When installing charlock_holmes don't mind any errors that might occur, that's ''normal''.}}
+
{{hc|/etc/webapps/gitlab-shell/config.yml|2=
 +
# Redis settings used for pushing commit notices to gitlab
 +
redis:
 +
  bin: /usr/bin/redis-cli
 +
  host: 127.0.0.1
 +
  port: 6379
 +
  # pass: redispass # Allows you to specify the password for Redis
 +
  database: 5 # Use different database, default up to 16
 +
  socket: /var/run/redis/redis.sock # '''uncomment''' this line
 +
  namespace: resque:gitlab
 +
}}
  
Because systemd requires full path to binaries to launch (the path is not enough), create a symbolic link in /home/gitlab/bin/ that points to the **bundle** executable. We'll also add the folder to gitlab's PATH:
+
=== Further configuration ===
# sudo -u gitlab -H mkdir /home/gitlab/bin
 
# sudo -u gitlab -H sh -c "ln -s \$(ruby -rubygems -e 'puts Gem.user_dir')/bin/bundle /home/gitlab/bin/"
 
# sudo -u gitlab -H sh -c 'echo "export PATH=/home/gitlab/bin:$PATH" >> /home/gitlab/.bashrc'
 
  
 +
==== Database backend ====
 +
A Database backend will be required before Gitlab can be run. Currently GitLab supports [[MariaDB]] and [[PostgreSQL]]. By default, GitLab assumes you will use MySQL. Extra work is needed if you plan to use PostgreSQL.
  
Clone Gitlab's stable repository:
+
==== MariaDB ====
# cd /home/gitlab
+
To set up MySQL (MariaDB) you need to create a database called {{ic|gitlabhq_production}} along with a user (default: {{ic|gitlab}}) who has full privileges to the database:
# sudo -H -u gitlab git clone -b stable git://github.com/gitlabhq/gitlabhq.git gitlab
 
# cd gitlab
 
# sudo -H -u gitlab git checkout v3.1.0
 
# sudo -u gitlab mkdir -pv tmp
 
  
===Basic configuration===
+
{{hc|$ mysql -u root -p|2=
 +
mysql> CREATE DATABASE `gitlabhq_production` DEFAULT CHARACTER SET `utf8` COLLATE `utf8_unicode_ci`;
 +
mysql> CREATE USER 'gitlab'@'localhost' IDENTIFIED BY 'password';
 +
mysql> GRANT ALL ON `gitlabhq_production`.* TO 'gitlab'@'localhost';
 +
mysql> \q
 +
}}
  
First we need to rename the example file.
+
Try connecting to the new database with the new user:
  
  # sudo -u gitlab cp config/gitlab.yml.example config/gitlab.yml
+
  $ mysql -u '''gitlab''' -p -D gitlabhq_production
  
The options are pretty straightforward. You can skip this part as it is quite detailed. Open {{ic|/home/gitlab/gitlab/config/gitlab.yml}} with your favorite editor and check the settings below.
+
Copy the MySQL template file before configuring it:
  
====Web application specific settings====
+
# cp /usr/share/doc/gitlab/database.yml.mysql /etc/webapps/gitlab/database.yml
  
{{hc|/home/gitlab/gitlab/config/gitlab.yml|<nowiki>
+
Next you will need to open {{ic|/etc/webapps/gitlab/database.yml}} and set {{ic|username:}} and {{ic|password:}} for the {{ic|gitlabhq_production}}:
host: myhost.example.com
 
port: 80
 
https: false
 
</nowiki>}}
 
  
*{{ic|host}}: Enter your [[Wikipedia:Fully_qualified_domain_name|Fully Qualified Domain Name]].
+
{{hc|/etc/webapps/gitlab/database.yml|
 +
#
 +
# PRODUCTION
 +
#
 +
production:
 +
  adapter: mysql2
 +
  encoding: utf8
 +
  collation: utf8_general_ci
 +
  reconnect: false
 +
  database: gitlabhq_production
 +
  pool: 10
 +
  username: '''username'''
 +
  password: '''"password"'''
 +
  # host: localhost
 +
  # socket: /var/run/mysqld/mysqld.sock # If running MariaDB as socket
 +
...
 +
}}
  
====Email used for notification====
+
It should not be set as world readable, e.g. only processes running under the {{ic|gitlab}} user should have read/write access:
  
{{hc|/home/gitlab/gitlab/config/gitlab.yml|<nowiki>
+
# chmod 600 /etc/webapps/gitlab/database.yml
from: notify@example.com
+
# chown gitlab:gitlab /etc/webapps/gitlab/database.yml
</nowiki>}}
 
  
This is how the mail address will be shown for mail notifications. Gitlab needs the sendmail command in order to send emails (for things like lost password recovery, new user addition etc). This command is provided by packages such as [[msmtp]], [[postfix]], [[sendmail]] etc, but you can only have one of them installed. First, check whether you already have the sendmail command:
+
For more info and other ways to create/manage MySQL databases, see the [https://mariadb.org/docs/ MariaDB documentation] and the [https://github.com/gitlabhq/gitlabhq/blob/6-5-stable/doc/install/installation.md GitLab official (generic) install guide].
  
# ls /usr/sbin/sendmail
+
==== PostgreSQL ====
 +
Login to PostgreSQL and create the {{ic|gitlabhq_production}} database with along with it's user. Remember to change {{ic|your_username_here}} and {{ic|your_password_here}} to the real values:
  
If you get a ‘cannot access /usr/bin/sendmail’ then install one of the above packages.
+
# psql -d template1
  
====Application specific settings====
+
{{bc|1=
 +
template1=# CREATE USER your_username_here WITH PASSWORD 'your_password_here';
 +
template1=# ALTER USER your_username_here SUPERUSER;
 +
template1=# CREATE DATABASE gitlabhq_production OWNER your_username_here;
 +
template1=# \q
 +
}}
  
{{hc|/home/gitlab/gitlab/config/gitlab.yml|<nowiki>
+
{{Note|The reason for creating the user as a superuser is that GitLab is trying to be "smart" and install extensions (not just create them in it's own userspace). And this is only allowed by superusers in Postgresql.}}
default_projects_limit: 10
 
# backup_path: "/vol/backups"   # default: Rails.root + backups/
 
# backup_keep_time: 604800      # default: 0 (forever) (in seconds)
 
</nowiki>}}
 
  
*{{ic|default_projects_limit}}: As the name suggests, this integer defines the default number of projects new users have. The number can change from within Gitlab by an administrator.
+
Try connecting to the new database with the new user to verify it works:
*{{ic|backup_path}}: The path where backups are stored. Default location is {{ic|/home/gitlab/gitlab/backups}}. The {{ic|backups}} folder is created automatically after first backup.
 
*{{ic|backup_keep_time}}: Time to preserve backups. The default option is to never be deleted.
 
  
Also check [[#Backup_and_restore| Backup and restore]].
+
# psql -d gitlabhq_production
  
====Git Hosting configuration====
+
Copy the PostgreSQL template file before configuring it (overwriting the default MySQL configuration file):
  
{{hc|/home/gitlab/gitlab/config/gitlab.yml|<nowiki>
+
# cp /usr/share/doc/gitlab/database.yml.postgresql /etc/webapps/gitlab/database.yml
admin_uri: git@localhost:gitolite-admin
 
base_path: /home/git/repositories/
 
hooks_path: /home/git/share/gitolite/hooks/
 
# host: localhost
 
git_user: git
 
upload_pack: true
 
receive_pack: true
 
# port: 22
 
</nowiki>}}
 
  
*{{ic|admin_uri}}: Do not change it. Leave as is.
+
Open the new {{ic|/etc/webapps/gitlab/database.yml}} and set the values for {{ic|username:}} and {{ic|password:}}. For example:
*{{ic|base_path}}: The path where gitolite's repositories reside. If the repositories directory is different than the default one, change it here.
 
*{{ic|hooks_path}}: change default setting to /home/git/share/gitolite/hooks/
 
*{{ic|host}}: Should point to your FQDN.
 
*{{ic|git_user}}: Name of the git user we created.
 
*{{ic|upload_pack}}:
 
*{{ic|receive_pack}}:  
 
  
*{{ic|port}}: ssh port which git should use. Default one is 22. If you want to change it for safety reasons, do not forget to also add the port number to {{ic|.ssh/config}}.
+
{{hc|/etc/webapps/gitlab/database.yml|
 
+
#
{{hc|/home/gitlab/gitlab/.ssh/config|<nowiki>
+
# PRODUCTION
Host localhost
+
#
Port 5000
+
production:
</nowiki>}}
+
  adapter: postgresql
 +
  encoding: unicode
 +
  database: gitlabhq_production
 +
  pool: 10
 +
  username: your_username_here
 +
  password: "your_password_here"
 +
  # host: localhost
 +
  # port: 5432
 +
  # socket: /tmp/postgresql.sock
 +
...
 +
}}
  
====Git settings====
+
For our purposes (unless you know what you are doing), you do not need to worry about configuring the other databases listed in {{ic|/etc/webapps/gitlab/database.yml}}. We only need to set up the production database to get GitLab working.
  
{{hc|/home/gitlab/gitlab/config/gitlab.yml|<nowiki>
+
==== Firewall ====
path: /usr/bin/git
 
git_max_size: 5242880 # 5.megabytes
 
git_timeout: 10
 
</nowiki>}}
 
  
*{{ic|git_max_size}}: Max size of git objects like commits, in bytes,.This value can be increased if you have very large commits.
+
If you want to give direct access to your Gitlab installation through an [[iptables]] firewall, you may need to adjust the port and the network address:
*{{ic|git_timeout}}: git timeout to read commit, in seconds.
 
  
===Database selection===
+
# iptables -A tcp_inbound -p TCP -s '''192.168.1.0/24''' --destination-port '''80''' -j ACCEPT
  
SQLite support in Gitlab is now deprecated. See [https://github.com/gitlabhq/gitlabhq/pull/2093 this bug report].
+
To enable API-access:
  
====MySQL====
+
# iptables -A tcp_inbound -p TCP -s '''192.168.1.0/24''' --destination-port '''8080''' -j ACCEPT
  
[[pacman|Install]] {{Pkg|mysql}} from the [[official repositories]] and start the [[daemon]]. Create the database and do not forget to replace {{ic|your_password_here}} with a real one.
+
If you are behind a router, do not forget to forward this port to the running GitLab server host, if you want to allow WAN-access.
# mysql -u root -p
 
 
mysql> create database gitlabhq_production;
 
mysql> create user 'gitlab'@'localhost' identified by 'your_password_here';
 
mysql> grant all privileges on gitlabhq_production.* to 'gitlab'@'localhost' with grant option;
 
mysql> exit;
 
  
Copy the example configuration file and make sure to update username/password in {{ic|config/database.yml}} at production section:
+
==== Initialize Gitlab database ====
# sudo -u gitlab cp config/database.yml.mysql config/database.yml
 
  
===Install gems===
+
Start the [[Redis]] server before we create the database.
This could take a while as it installs all required libraries.
 
  
  # cd /home/gitlab/gitlab
+
Initialize the database and activate advanced features:
# export PATH=/home/gitlab/bin:$PATH
+
  # su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake gitlab:setup RAILS_ENV=production"
# sudo -u gitlab -H bundle install --deployment
 
  
{{Note|1= Using "--without development test" in bundle command line will ignore required packages for database backup and restore }}
+
Finally run the following commands to check your installation:
  
===Start redis server===
+
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake gitlab:env:info RAILS_ENV=production"
 +
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake gitlab:check RAILS_ENV=production"
  
Start the [[daemon]]. If you are using {{Pkg| initscripts}} you might want to add {{ic|redis}} to your {{ic|DAEMONS}} array in {{ic|rc.conf}}.
+
{{note|
 +
*The ''gitlab:env:info'' and ''gitlab:check'' commands will show a fatal error related to git. This is OK.
 +
*If ''gitlab:check'' fails with ''Check GitLab API access: FAILED. code: 401'', see [https://wiki.archlinux.org/index.php/gitlab#401_Unauthorized_on_all_API_access] and [https://wiki.archlinux.org/index.php/gitlab#.2Fetc.2Fwebapps.2Fgitlab.2Fsecret_is_empty] of the troubleshoot section to resolve this.
 +
*The ''gitlab:check'' will complain about missing initscripts. This is nothing to worry about, as [[systemd]] service files are used instead (which GitLab does not recognize).
 +
}}
  
{{Note|redis might already be running, causing a FAIL message to appear. Check if it is already running with {{ic|rc.d list redis}}.}}
+
==== Configure Git User  ====
 +
# cd /usr/share/webapps/gitlab
 +
# sudo -u gitlab -H git config --global user.name  "GitLab"
 +
# sudo -u gitlab -H git config --global user.email "example@example.com"
 +
# sudo -u gitlab -H git config --global core.autocrlf "input"
  
If you have switched to [[systemd]], there is a service file included in the official package. See [[daemon]] how to enable it.
+
==== Adjust modifier bits ====
 +
(The gitlab check won't pass if the user and group ownership isn't configured properly)
  
===Populate the database===
+
# chmod -R ug+rwX,o-rwx /var/lib/gitlab/repositories/
 +
# chmod -R ug-s /var/lib/gitlab/repositories
 +
# find /var/lib/gitlab/repositories/ -type d -print0 | xargs -0 chmod g+s
  
# sudo -u gitlab bundle exec rake gitlab:app:setup RAILS_ENV=production
+
== Start and test GitLab ==
 +
{{note|See [[#Troubleshooting]] and log files inside the {{ic|/usr/share/webapps/gitlab/log}} directory for troubleshooting.}}
  
===Setup gitlab hooks===
+
Make sure [[MySQL]] or [[PostgreSQL]] and [[Redis]] are running and setup correctly.
  
# cp ./lib/hooks/post-receive /home/git/.gitolite/hooks/common/post-receive
+
After starting the database backends, we can start GitLab with its webserver (Unicorn) by [[start]]ing both the {{ic|gitlab-sidekiq}} and {{ic|gitlab-unicorn}} systemd units.
# chown git:git /home/git/.gitolite/hooks/common/post-receive
 
  
===Check status===
+
To automatically launch GitLab at startup, enable the {{ic|gitlab.target}}, {{ic|gitlab-sidekiq}} and {{ic|gitlab-unicorn}} services.
  
With the following commands we check if the steps we followed so far are configured properly. Before running the first command you must edit {{ic|/home/gitlab/gitlab/lib/tasks/gitlab/info.rake}}. The script cannot determine OS version; simply replace {{ic|os_name.squish!}} with {{ic|os_name &#61; "Arch Linux"}}.
+
Now test your GitLab instance by visiting http://localhost:8080 or http://yourdomain.com, you should be prompted to create a password:
  
# sudo -u gitlab -H bundle exec rake gitlab:env:info RAILS_ENV=production
+
{{bc|
# sudo -u gitlab -H bundle exec rake gitlab:check RAILS_ENV=production
+
username: root
 +
password: You'll be prompted to create one on your first visit.
 +
}}
  
{{hc|Example output|
+
== Upgrade database on updates ==
System information
+
After updating the {{Pkg|gitlab}} package, it is required to upgrade the database:
System:         Arch Linux
+
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake db:migrate RAILS_ENV=production"
Current User:  gitlab
 
Using RVM:      no
 
Ruby Version:  1.9.3p362
 
Gem Version:    1.8.23
 
Bundler Version:1.2.3
 
Rake Version:   10.0.1
 
  
GitLab information
+
Afterwards, restart gitlab-related services:
Version:       4.0.0
+
# systemctl daemon-reload
Revision:      8ef7b9b
+
# systemctl restart gitlab-sidekiq gitlab-unicorn gitlab-workhorse
Directory:      /home/gitlab/gitlab
 
DB Adapter:    mysql2
 
URL:            <nowiki>http://example.com</nowiki>
 
HTTP Clone URL: <nowiki>http://example.com/some-project.git</nowiki>
 
SSH Clone URL:  git@example.com:some-project.git
 
Using LDAP:    no
 
Using Omniauth: no
 
  
Gitolite information
+
== Advanced Configuration ==
Version:        v3.04-4-g4524f01
 
Admin URI:      git@example.com:gitolite-admin
 
Admin Key:      gitlab
 
Repositories:  /home/git/repositories/
 
Hooks:          /home/git/.gitolite/hooks/
 
Git:            /usr/bin/git
 
  
 +
=== Custom SSH Connection ===
 +
If you are running SSH on a non-standard port, you must change the GitLab user's SSH config:
 +
{{hc|/var/lib/gitlab/.ssh/config|2=
 +
host localhost      # Give your setup a name (here: override localhost)
 +
user gitlab        # Your remote git user
 +
port 2222          # Your port number
 +
hostname 127.0.0.1; # Your server name or IP
 
}}
 
}}
  
===Server testing and resque process===
+
You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the {{ic|/etc/webapps/gitlab/gitlab.yml}} file.
  
[http://defunkt.io/resque/ Resque] is a Redis-backed library for creating background jobs, placing those jobs on multiple queues, and processing them later. For the backstory, philosophy, and history of Resque's beginnings, please see this [https://github.com/blog/542-introducing-resque blog post].
+
=== HTTPS/SSL ===
  
Run resque process for processing queue:
+
==== Change GitLab configs ====
# sudo -u gitlab bundle exec rake environment resque:work QUEUE=* RAILS_ENV=production BACKGROUND=yes
+
Modify {{ic|/etc/webapps/gitlab/shell.yml}} so the url to your GitLab site starts with {{ic|https://}}.
 +
Modify {{ic|/etc/webapps/gitlab/gitlab.yml}} so that {{ic|https:}} setting is set to {{ic|true}}.
  
or use Gitlab's start script:
+
See also [[Apache HTTP Server#TLS/SSL]] and [[Let’s Encrypt]].
# sudo -u gitlab ./resque.sh
 
  
{{Note|If you run this as root, {{ic|/home/gitlab/gitlab/tmp/pids/resque_worker.pid}} will be owned by root causing the resque worker not to start via init script on next boot/service restart}}
+
==== Let's Encrypt ====
  
Gitlab application can be started with the next command:
+
To validate your URL, the Let's Encrypt process will try to access your gitlab server with something like {{ic|<nowiki>https://gitlab.</nowiki>''YOUR_SERVER_FQDN''/.well-known/acme-challenge/''A_LONG_ID''}}. But, due to gitlab configuration, every request to {{ic|gitlab.''YOUR_SERVER_FQDN''}} will be redirected to a proxy (gitlab-workhorse) that will not be able to deal with this URL.
# sudo -u gitlab bundle exec rails s -e production
 
  
Open {{ic|localhost:3000}} with your favorite browser and you should see Gitlab's sign in page. In case you missed it, the default login/password are:
+
To bypass this issue, you can use the Let's Encrypt webroot configuration, setting the webroot at {{ic|/srv/http/letsencrypt/}}.
  
login.........admin@local.host
+
Additionally, force the Let's Encrypt request for gitlab to be redirected to this webroot by adding the following:
password......5iveL!fe
 
  
Since this is a thin web server, it is only for test purposes. You may close it with {{Keypress|Ctrl+c}}. Follow instructions below to make Gitlab run with a real web server.
+
{{hc|/etc/http/conf/extra/gitlab.conf|
 +
Alias "/.well-known"  "/srv/http/letsencrypt/.well-known"
 +
RewriteCond  %{REQUEST_URI} !/\.well-known/.*
 +
}}
  
==Web server configuration==
+
===Web server configuration===
 +
If you want to integrate Gitlab into a running web server instead of using its build-in http server Unicorn, then follow these instructions.
  
 +
===== Node.js =====
 +
You can easily set up an http proxy on port 443 to proxy traffic to the GitLab application on port 8080 using http-master for Node.js. After you have creates your domain's OpenSSL keys and have gotten you CA certificate (or self signed it), then go to https://github.com/CodeCharmLtd/http-master to learn how easy it is to proxy requests to GitLab using HTTPS. http-master is built on top of [https://github.com/nodejitsu/node-http-proxy node-http-proxy].
  
===Unicorn only===
+
==== Nginx and unicorn ====
 +
Copy {{ic|/usr/share/doc/gitlab/nginx.conf.example}} or {{ic|/usr/share/doc/gitlab/nginx-ssl.conf.example}} to {{ic|/etc/nginx/servers-available/gitlab}}. See [[Nginx#Managing server entries]] for more information.
  
Edit {{ic|/home/gitlab/gitlab/config/unicorn.rb}} uncomment:
+
Update the {{ic|/etc/nginx/servers-available/gitlab}} file and [[restart]] the nginx service.
  
  listen 8080 # listen to port 8080 on all TCP interfaces
+
If you are unable to authenticate, add the following headers to {{ic|/etc/nginx/servers-available/gitlab}}:
 +
  proxy_set_header    X-Forwarded-Ssl    on; # Only when using SSL
 +
proxy_set_header    X-Frame-Options    SAMEORIGIN;
  
Create {{ic|/etc/rc.d/unicorn-gitlab}}.
+
===== Alternative Example =====
<pre>
+
{{Note|You may need to change {{ic|localhost:8080}} with the correct gitlab address and {{ic|example.com}} to your desired server name.}}
#!/bin/bash
+
{{Tip|See [[Nginx#TLS.2FSSL|Nginx#TLS/SSL]] before enabling SSL.}}
 +
Create a file {{ic|/etc/nginx/servers-available/gitlab}} with the following content:
  
. /etc/rc.conf
+
{{hc|/etc/nginx/servers-available/gitlab|2=
. /etc/rc.d/functions
+
# Created by: Sameer Naik
 +
# Contributor: francoism90
 +
# Source: https://gist.github.com/sameersbn/becd1c976c3dc4866ef8
  
 +
upstream gitlab-workhorse {
 +
  server unix:/run/gitlab/gitlab-workhorse.socket fail_timeout=0;
 +
}
  
PID=`pidof -o %PPID /usr/bin/ruby`
 
case "$1" in
 
  start)
 
    stat_busy "Starting unicorn"
 
    [ -z "$PID" ] && sudo -u gitlab bash  -c  "source /home/gitlab/.bash_profile && cd /home/gitlab/gitlab/ && bundle exec unicorn_rails -c config/unicorn.rb -E production -D"
 
    if [ $? -gt 0 ]; then
 
      stat_fail
 
    else
 
      add_daemon unicorn
 
      stat_done
 
    fi
 
    ;;
 
  stop)
 
    stat_busy "Stopping unicorn"
 
    [ ! -z "$PID" ]  && kill $PID &> /dev/null
 
    if [ $? -gt 0 ]; then
 
      stat_fail
 
    else
 
      rm_daemon unicorn
 
      stat_done
 
    fi
 
    ;;
 
  restart)
 
    $0 stop
 
    sleep 1
 
    $0 start
 
    ;;
 
  *)
 
    echo "usage: $0 {start|stop|restart}"
 
esac
 
exit 0
 
</pre>
 
  
Start '''unicorn''':
+
server {
 +
  listen 80;
 +
  #listen 443 ssl; # uncomment to enable ssl
 +
  keepalive_timeout 70;
 +
  server_name example.com
 +
  server_tokens off;
 +
  #ssl_certificate ssl/example.com.crt;
 +
  #ssl_certificate_key ssl/example.com.key;
 +
  charset utf-8;
 +
  root /dev/null;
 +
 
 +
  # Increase this if you want to upload larger attachments
 +
  client_max_body_size 20m;
 +
 
 +
  location / {
 +
      proxy_read_timeout 300;
 +
      proxy_connect_timeout 300;
 +
      proxy_redirect off;
 +
     
 +
      proxy_set_header X-Forwarded-Proto $scheme;
 +
      proxy_set_header Host $http_host;
 +
      proxy_set_header X-Real-IP $remote_addr;
 +
      proxy_set_header X-Forwarded-Ssl on;
 +
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 +
      proxy_set_header X-Forwarded-Proto $scheme;
 +
      proxy_set_header X-Frame-Options SAMEORIGIN;
 +
     
 +
      proxy_pass http://gitlab-workhorse;
 +
  } 
 +
}
 +
}}
  
# /etc/rc.d/unicorn-gitlab start
+
==== Apache and unicorn ====
  
Test it http://localhost:8080
+
[[Install]] {{Pkg|apache}} from the [[official repositories]].
  
Add it to DAEMONS array in /etc/rc.conf
+
=====Configure Unicorn=====
  
Redirect http port to unicorn server
+
As the official installation guide instructs, copy the unicorn configuration file:
 +
# sudo -u git -H cp /usr/share/webapps/gitlab/config/unicorn.rb.example /usr/share/webapps/gitlab/config/unicorn.rb
  
  # iptables -A PREROUTING -t nat -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080
+
Now edit {{ic|config/unicorn.rb}} and add a listening port by uncommenting the following line:
 +
  listen "127.0.0.1:8080"
  
And test again, now http://localhost
+
{{Tip| You can set a custom port if you want. Just remember to also include it in Apache's virtual host. See below.}}
  
===Nginx and unicorn===
+
=====Create a virtual host for Gitlab=====
  
[[pacman|Install]] {{Pkg|nginx}} from the [[official repositories]].
+
Create a configuration file for Gitlab’s virtual host and insert the lines below adjusted accordingly. For the ssl section see [[LAMP#SSL]]{{Broken section link}}. If you do not need it, remove it. Notice that the SSL virtual host needs a specific IP instead of generic. Also if you set a custom port for Unicorn, do not forget to set it at the BalanceMember line.
  
Run these commands to setup nginx:
+
You can use these [https://gitlab.com/gitlab-org/gitlab-recipes/blob/079f70dd2c091434a8dd04ed5b1a0d0e937cd361/web-server/apache/gitlab-ssl-apache2.4.conf examples] to get you started.
  
# wget https://raw.github.com/gitlabhq/gitlab-recipes/master/nginx/gitlab -P /etc/nginx/sites-available/
+
=====Enable host and start unicorn=====
# ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
 
  
Edit {{ic|/etc/nginx/sites-enabled/gitlab}} and change YOUR_SERVER_IP and YOUR_SERVER_FQDN to the IP address and fully-qualified domain name of the host serving Gitlab. As you can see nginx needs to access {{ic|/home/gitlab/gitlab/tmp/sockets/gitlab.socket}} socket file. You have to be able to run {{ic|sudo -u http ls /home/gitlab/gitlab/tmp/sockets/gitlab.socket}} successfully. Otherwise setup access to the directory:
+
Enable your Gitlab virtual host and reload [[Apache]]:
+
{{hc|/etc/httpd/conf/httpd.conf| Include /etc/httpd/conf/extra/gitlab.conf}}
# chgrp http /home/gitlab
 
# chmod u=rwx,g=rx,o= /home/gitlab
 
  
Restart gitlab.service, resque.service and nginx.
+
Copy the Apache  gitlab.conf file
  
[http://unicorn.bogomips.org/ Unicorn] is an HTTP server for Rack applications designed to only serve fast clients on low-latency, high-bandwidth connections and take advantage of features in Unix/Unix-like kernels. First we rename the example file and then we start unicorn:
+
# cp /usr/share/doc/gitlab/apache.conf.example /etc/httpd/conf/extra/gitlab.conf
  
# cd /home/gitlab/gitlab
+
Finally [[start]] {{ic|gitlab-unicorn.service}}.
# sudo -u gitlab cp config/unicorn.rb.orig config/unicorn.rb
 
# sudo -u gitlab bundle exec unicorn_rails -c config/unicorn.rb -E production -D
 
  
===Apache and unicorn===
+
=== Gitlab-workhorse ===
  
[[pacman|Install]] {{Pkg|apache}} from the [[official repositories]].
+
{{Expansion|This section needs configuration instructions.}}
  
====Configure Unicorn====
+
Since 8.0 GitLab uses separate HTTP server {{Pkg|gitlab-workhorse}} for large HTTP requests like Git push/pull. If you want to use this instead of SSH, install the {{Pkg|gitlab-workhorse}} package, enable {{ic|gitlab-workhorse.service}} and configure web server for this. {{Pkg|gitlab-workhorse}} should now be preferred over {{ic|gitlab-unicorn}} according to the GitLab team: https://gitlab.com/gitlab-org/gitlab-ce/issues/22528#note_16036216
  
As the official installation guide instructs, copy the unicorn configuration file:
+
{{Note|Unicorn is still needed so don't disable or stop {{ic|gitlab-unicorn.service}}. If you've changed the port Unicorn listens at, [[edit]] the {{ic|-authBackend}} setting in {{ic|gitlab-workhorse.service}} accordingly}}
# sudo -u gitlab -H cp /home/gitlab/gitlab/config/unicorn.rb.example /home/gitlab/gitlab/config/unicorn.rb
 
  
Now edit {{ic|config/unicorn.rb}} and add a listening port by uncommenting the following line:
+
By default {{Pkg|gitlab-workhorse}} listens on {{ic|/run/gitlab/gitlab-workhorse.socket}}. You can [[edit]] {{ic|gitlab-workhorse.service}} and change the parameter {{ic|-listenAddr}} to make it listen on an address, for example {{ic|-listenAddr 127.0.0.1:8181}}. If listening on an address you also need to set the network type to {{ic|-listenNetwork tcp}}
listen "127.0.0.1:8080"
 
  
{{Tip| You can set a custom port if you want. Just remember to also include it in Apache's virtual host. See below.}}
+
When using nginx remember to edit your nginx configuration file. To switch from gitlab-unicorn to gitlab-workhorse edit the two following settings accordingly
 +
{{hc|/etc/nginx/servers-available/gitlab|2=
 +
upstream gitlab {
 +
  server unix:/run/gitlab/gitlab-workhorse.socket fail_timeout=0;
 +
}
  
====Create a virtual host for Gitlab====
+
...
 +
     
 +
      proxy_pass http://unix:/run/gitlab/gitlab-workhorse.socket;
 +
  } 
 +
}
 +
}}
  
Create a configuration file for Gitlab’s virtual host and insert the lines below adjusted accordingly. For the ssl section see [[LAMP#SSL]]. If you do not need it, remove it. Notice that the SSL virtual host needs a specific IP instead of generic. Also if you set a custom port for Unicorn, do not forget to set it at the BalanceMember line.
+
==Useful Tips==
  
# mkdir -pv /etc/httpd/conf/vhosts/
+
===Fix Rake Warning===
 +
When running rake tasks for the gitlab project, this error will occur: {{ic|fatal: Not a git repository (or any of the parent directories): .git}}. This is a bug in bundler, and it can be safely ignored. However, if you want to git rid of the error, the following method can be used:
  
{{hc|/etc/httpd/conf/vhosts/gitlab|
+
{{bc|1=
<VirtualHost *:80>
+
# cd /usr/share/webapps/gitlab
  ServerName gitlab.myserver.com
+
# sudo -u gitlab git init
  ServerAlias www.gitlab.myserver.com
+
# sudo -u gitlab git commit -m "initial commit" --allow-empty
  DocumentRoot /home/gitlab/gitlab/public
+
}}
  ErrorLog /var/log/httpd/gitlab_error_log
 
  CustomLog /var/log/httpd/gitlab_access_log combined
 
  
  <Proxy balancer://unicornservers>
+
===Hook into /var===
      BalancerMember http://127.0.0.1:8080
+
{{bc|1=
  </Proxy>
+
# mkdir -m700 /var/log/gitlab /var/tmp/gitlab
 +
# chown gitlab:gitlab /var/log/gitlab /var/tmp/gitlab
 +
# sudo -u gitlab -i
 +
# cd ~/gitlab
 +
# d=log; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d
 +
# d=tmp; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d
 +
}}
  
  <Directory /home/gitlab/gitlab/public>
+
===Hidden options===
    AllowOverride All
+
Go to Gitlab's home directory:
    Options -MultiViews
+
# cd /usr/share/webapps/gitlab
  </Directory>
 
  
  RewriteEngine on
+
and run:
  RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
+
{{hc|<nowiki># rake -T | grep gitlab</nowiki>|<nowiki>
  RewriteRule ^/(.*)$ balancer://unicornservers%{REQUEST_URI} [P,QSA,L]
+
rake gitlab:app:check                        # GITLAB | Check the configuration of the GitLab Rails app
 +
rake gitlab:backup:create                    # GITLAB | Create a backup of the GitLab system
 +
rake gitlab:backup:restore                    # GITLAB | Restore a previously created backup
 +
rake gitlab:check                            # GITLAB | Check the configuration of GitLab and its environment
 +
rake gitlab:cleanup:block_removed_ldap_users  # GITLAB | Cleanup | Block users that have been removed in LDAP
 +
rake gitlab:cleanup:dirs                      # GITLAB | Cleanup | Clean namespaces
 +
rake gitlab:cleanup:repos                    # GITLAB | Cleanup | Clean repositories
 +
rake gitlab:env:check                        # GITLAB | Check the configuration of the environment
 +
rake gitlab:env:info                          # GITLAB | Show information about GitLab and its environment
 +
rake gitlab:generate_docs                    # GITLAB | Generate sdocs for project
 +
rake gitlab:gitlab_shell:check                # GITLAB | Check the configuration of GitLab Shell
 +
rake gitlab:import:all_users_to_all_groups    # GITLAB | Add all users to all groups (admin users are added as owners)
 +
rake gitlab:import:all_users_to_all_projects  # GITLAB | Add all users to all projects (admin users are added as masters)
 +
rake gitlab:import:repos                      # GITLAB | Import bare repositories from gitlab_shell -> repos_path into GitLab project instance
 +
rake gitlab:import:user_to_groups[email]      # GITLAB | Add a specific user to all groups (as a developer)
 +
rake gitlab:import:user_to_projects[email]    # GITLAB | Add a specific user to all projects (as a developer)
 +
rake gitlab:satellites:create                # GITLAB | Create satellite repos
 +
rake gitlab:setup                            # GITLAB | Setup production application
 +
rake gitlab:shell:build_missing_projects      # GITLAB | Build missing projects
 +
rake gitlab:shell:install[tag,repo]           # GITLAB | Install or upgrade gitlab-shell
 +
rake gitlab:shell:setup                      # GITLAB | Setup gitlab-shell
 +
rake gitlab:sidekiq:check                    # GITLAB | Check the configuration of Sidekiq
 +
rake gitlab:test                              # GITLAB | Run all tests
 +
rake gitlab:web_hook:add                      # GITLAB | Adds a web hook to the projects
 +
rake gitlab:web_hook:list                    # GITLAB | List web hooks
 +
rake gitlab:web_hook:rm                      # GITLAB | Remove a web hook from the projects
 +
rake setup                                    # GITLAB | Setup gitlab db
 +
</nowiki>}}
  
  ProxyPass /uploads !
+
===Backup and restore===
  ProxyPass / balancer://unicornservers/
 
  ProxyPassReverse / balancer://unicornservers/
 
  ProxyPreserveHost on
 
  
  <Proxy *>
+
Create a backup of the gitlab system:
      Order deny,allow
+
# sudo -u gitlab -H rake RAILS_ENV=production gitlab:backup:create
      Allow from all
 
  </Proxy>
 
</VirtualHost>
 
  
<VirtualHost MY_IP:443>
+
Restore the previously created backup file {{ic|/home/gitlab/gitlab/tmp/backups/20130125_11h35_1359131740_gitlab_backup.tar}}:
  ServerName gitlab.myserver.com
+
# sudo -u gitlab -H rake RAILS_ENV=production gitlab:backup:restore BACKUP=/home/gitlab/gitlab/tmp/backups/20130125_11h35_1359131740
  ServerAlias www.gitlab.myserver.com
 
  DocumentRoot /home/gitlab/gitlab/public
 
  ErrorLog /var/log/httpd/gitlab_error_log
 
  CustomLog /var/log/httpd/gitlab_access_log combined
 
  
  <Proxy balancer://unicornservers>
+
{{Note| Backup folder is set in {{ic|config/gitlab.yml}}. GitLab backup and restore is documented [https://github.com/gitlabhq/gitlabhq/blob/master/doc/raketasks/backup_restore.md here].}}
      BalancerMember http://127.0.0.1:8080
 
  </Proxy>
 
  
  <Directory /home/gitlab/gitlab/public>
+
===Migrate from sqlite to mysql===
    AllowOverride All
 
    Options -MultiViews
 
  </Directory>
 
  
  RewriteEngine on
+
Get latest code as described in [[#Update Gitlab]]{{Broken section link}}.
  RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
+
Save data.
  RewriteRule ^/(.*)$ balancer://unicornservers%{REQUEST_URI} [P,QSA,L]
+
# cd /home/gitlab/gitlab
 +
# sudo -u gitlab bundle-2.3 exec rake db:data:dump RAILS_ENV=production
  
  ProxyPass /uploads !
+
Follow [[#Mysql]]{{Broken section link}} instructions and then setup the database.
  ProxyPass / balancer://unicornservers/
+
# sudo -u gitlab bundle-2.3 exec rake db:setup RAILS_ENV=production
  ProxyPassReverse / balancer://unicornservers/
 
  ProxyPreserveHost on
 
  
  <Proxy *>
+
Finally restore old data.
      Order deny,allow
+
# sudo -u gitlab bundle-2.3 exec rake db:data:load RAILS_ENV=production
      Allow from all
 
  </Proxy>
 
  
  SSLEngine on
+
===Running GitLab with rvm===
  SSLCertificateFile /home/gitlab/gitlab/ssl.cert
 
  SSLCertificateKeyFile /home/gitlab/gitlab/ssl.key
 
</VirtualHost>
 
}}
 
  
====Enable host and start unicorn====
+
To run gitlab with rvm first you have to set up an rvm:
  
Enable your Gitlab virtual host and reload [[Apache]]:
+
  curl -L https://get.rvm.io | bash -s stable --ruby=1.9.3
{{hc|/etc/httpd/conf/httpd.conf|Include conf/vhosts/gitlab}}
 
  
Finally start unicorn:
+
{{Note|Version 1.9.3 is currently recommended to avoid some compatibility issues.}}
  
# cd /home/gitlab/gitlab
+
For the complete installation you will want to be the final user (e.g. {{ic|git}}) so make sure to switch to this user and activate your rvm:
# sudo -u gitlab bundle exec unicorn_rails -c config/unicorn.rb -E production -D
 
  
==SystemD support==
+
  su - git
 +
  source "$HOME/.rvm/scripts/rvm"
  
Note that you don't need the systemd units to launch shell scripts as suggested by the gitlab authors. Just make sure the ExecStart line points to the full path of the **bundle** executable.
+
Then continue with the installation instructions from above. However, the systemd scripts will not work this way, because the environment for the rvm is not activated. The recommendation here is to create to separate shell scripts for {{ic|unicorn}} and {{ic|sidekiq}} to activate the environment and then start the service:
  
Create:
+
{{hc|gitlab.sh|<nowiki>
{{hc|/etc/systemd/system/gitlab.service|<nowiki>
+
#!/bin/sh
[Unit]
+
source `/home/git/.rvm/bin/rvm 1.9.3 do rvm env --path`
Description=Gitlab Unicorn Rails server
+
bundle-2.3 exec "unicorn_rails -c /usr/share/webapps/gitlab/config/unicorn.rb -E production"</nowiki>
 +
}}
  
[Service]
+
{{hc|sidekiq.sh|<nowiki>
Type=simple
+
#!/bin/sh
SyslogIdentifier=gl-unicorn
+
source `/home/git/.rvm/bin/rvm 1.9.3 do rvm env --path`
User=gitlab
+
case $1 in
PIDFile=/home/gitlab/gitlab/tmp/pids/unicorn.pid
+
    start)
WorkingDirectory=/home/gitlab/gitlab
+
        bundle-2.3 exec rake sidekiq:start RAILS_ENV=production
TimeoutStartSec=600
+
        ;;
 +
    stop)
 +
        bundle-2.3 exec rake sidekiq:stop RAILS_ENV=production
 +
        ;;
 +
    *)
 +
        echo "Usage $0 {start|stop}"
 +
esac
 +
</nowiki>}}
  
ExecStart=/home/gitlab/bin/bundle exec unicorn_rails -c /home/gitlab/gitlab/config/unicorn.rb -E production -D
+
Then modify the above systemd files so they use these scripts. Modify the given lines:
ExecReload=/bin/kill -HUP $MAINPID
 
ExecStop=/bin/kill -QUIT $MAINPID
 
  
[Install]
+
{{hc|gitlab.service|<nowiki>
WantedBy=multi-user.target
+
ExecStart=/home/git/bin/gitlab.sh
 +
</nowiki>}}
 +
{{hc|sidekiq.service|<nowiki>
 +
ExecStart=/home/git/bin/sidekiq.sh start
 +
ExecStop=/home/git/bin/sidekiq.sh stop
 
</nowiki>}}
 
</nowiki>}}
  
{{hc|/etc/systemd/system/resque.service|<nowiki>
+
===Sending mails from Gitlab via SMTP===
  
[Unit]
+
You might want to use a gmail (or other mail service) to send mails from your gitlab server. This avoids the need to install a mail daemon on the gitlab server.
Description=Gitlab Resque
 
  
[Service]
+
Adjust {{ic|smtp_settings.rb}} according to your mail server settings:
Type=simple
 
SyslogIdentifier=gl-resque
 
User=gitlab
 
PIDFile=/home/gitlab/gitlab/tmp/pids/resque_worker.pid
 
WorkingDirectory=/home/gitlab/gitlab
 
TimeoutStartSec=600
 
  
ExecStart=/home/gitlab/bin/bundle exec rake environment resque:work QUEUE=post_receive,mailer,system_hook RAILS_ENV=production PIDFILE=tmp/pids/resque_worker.pid
+
{{hc|/usr/share/webapps/gitlab/config/initializers/smtp_settings.rb|<nowiki>
ExecReload=/bin/kill -HUP $MAINPID
+
if Rails.env.production?
ExecStop=/bin/kill -QUIT $MAINPID
+
  Gitlab::Application.config.action_mailer.delivery_method = :smtp
  
[Install]
+
  Gitlab::Application.config.action_mailer.smtp_settings = {
WantedBy=multi-user.target
+
    address:              'smtp.gmail.com',
</nowiki>
+
    port:                587,
}}
+
    domain:              'gmail.com',
 +
    user_name:            'username@gmail.com',
 +
    password:            'application password',
 +
    authentication:      'plain',
 +
    enable_starttls_auto: true
 +
  }
 +
end</nowiki>}}
  
Also see: https://github.com/gitlabhq/gitlab-recipes/issues/14
+
Gmail will reject mails received this way (and send you a mail that it did). You will need to disable secure authentication (follow the link in the rejection mail) to work around this. The more secure approach is to enable two-factor authentication for username@gmail.com and to set up an application password for this configuration file.
  
==Useful Tips==
+
==Troubleshooting==
===Hook into /var===
 
  sudo mkdir -m700 /var/log/gitlab /var/tmp/gitlab
 
  sudo chown gitlab:gitlab /var/log/gitlab /var/tmp/gitlab
 
  sudo -u gitlab -i
 
  cd ~/gitlab
 
  d=log; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d
 
  d=tmp; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d
 
  
===Hidden options===
+
Sometimes things may not work as expected. Be sure to visit the [https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide Trouble Shooting Guide].
Go to Gitlab's home directory
 
# cd /home/gitlab/gitlab
 
  
and run
+
=== HTTPS is not green (gravatar not using https) ===
# rake -T | grep gitlab
+
Redis caches gravatar images, so if you have visited your GitLab with http, then enabled https, gravatar will load up the non-secure images. You can clear the cache by doing
  
These are the options so far:
+
  cd /usr/share/webapps/gitlab
rake gitlab:app:backup_create      # GITLAB | Create a backup of the gitlab system
+
  RAILS_ENV=production bundle-2.3 exec rake cache:clear
rake gitlab:app:backup_restore    # GITLAB | Restore a previously created backup
 
  rake gitlab:app:enable_automerge  # GITLAB | Enable auto merge
 
  rake gitlab:app:setup              # GITLAB | Setup production application
 
rake gitlab:app:status            # GITLAB | Check gitlab installation status
 
rake gitlab:gitolite:update_hooks  # GITLAB | Rewrite hooks for repos
 
rake gitlab:gitolite:update_keys  # GITLAB | Rebuild each key at gitolite config
 
rake gitlab:gitolite:update_repos  # GITLAB | Rebuild each project at gitolite config
 
rake gitlab:test                  # GITLAB | Run both cucumber & rspec
 
  
===Backup and restore===
+
as the gitlab user.
  
Create a backup of the gitlab system:
+
=== 401 Unauthorized on all API access ===
# sudo -u gitlab -H rake RAILS_ENV=production gitlab:backup:create
+
Make 100% sure, that the files {{ic|/etc/webapps/gitlab/secret}} and {{ic|/etc/webapps/gitlab-shell/secret}} files contain something!
  
Restore the previously created backup file {{ic|/home/gitlab/gitlab/tmp/backups/20130125_11h35_1359131740_gitlab_backup.tar}}:
+
=== Error at push bad line length character: API ===
  # sudo -u gitlab -H rake RAILS_ENV=production gitlab:backup:restore BACKUP=/home/gitlab/gitlab/tmp/backups/20130125_11h35_1359131740
+
If you get the following error while trying to push
 +
  fatal: protocol error: bad line length character: API
  
{{Note| Backup folder is set in {{ic|conig.yml}}. Check [[#Application_specific_settings]].}}
+
Check that your {{ic|/etc/webapps/gitlab-shell/secret}} matches {{ic|/usr/share/webapps/gitlab/.gitlab_shell_secret}}
  
===Update Gitlab===
+
If it is not the same, recreate the file with the following command
 +
ln -s /etc/webapps/gitlab-shell/secret /usr/share/webapps/gitlab/.gitlab_shell_secret
  
When a new version is out follow the instructions at [https://github.com/gitlabhq/gitlabhq/wiki Github wiki]. A new release is out every 22nd of a month.
+
=== Errors after updating ===
 +
After updating the package from the AUR, the database migrations and asset updates will sometimes fail. These steps may resolve the issue, if a simple reboot does not.
  
===Migrate from sqlite to mysql===
+
First, move to the gitlab installation directory.
 +
# cd /usr/share/webapps/gitlab
  
Get latest code as described in [[#Update_Gitlab]].
+
If every gitlab page gives a 500 error, then the database migrations and the assets are probably stale. If not, skip this step.
Save data.
+
  # sudo -u gitlab -H bundle-2.3 exec rake db:migrate RAILS_ENV=production
# cd /home/gitlab/gitlab
 
  # sudo -u gitlab bundle exec rake db:data:dump RAILS_ENV=production
 
  
Follow [[#Mysql]] instructions and then setup the database.
+
If gitlab is constantly waiting for the deployment to finish, then the assets have probably not been recompiled.
  # sudo -u gitlab bundle exec rake db:setup RAILS_ENV=production
+
  # sudo -u gitlab -H bundle-2.3 exec rake gitlab:assets:clean gitlab:assets:compile cache:clear RAILS_ENV=production
  
Finally restore old data.
+
Finally, restart the gitlab services and test your site.
  # sudo -u gitlab bundle exec rake db:data:load RAILS_ENV=production
+
  # systemctl restart gitlab-unicorn gitlab-sidekiq gitlab-workhorse
  
==Troubleshooting==
+
=== /etc/webapps/gitlab/secret is empty ===
 +
This file is usually generated while installing the {{pkg|gitlab-shell}} and the {{pkg|gitlab}} packages, but in some cases it may need to be generated manually.
 +
# hexdump -v -n 64 -e '1/1 "%02x"' /dev/urandom > /etc/webapps/gitlab-shell/secret
 +
# chown root:gitlab /etc/webapps/gitlab-shell/secret
 +
# chmod 640 /etc/webapps/gitlab-shell/secret
  
Sometimes things may not work as expected. Be sure to visit the [https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide Trouble Shooting Guide].
+
# hexdump -v -n 64 -e '1/1 "%02x"' /dev/urandom > /etc/webapps/gitlab/secret
 +
# chown root:gitlab /etc/webapps/gitlab/secret
 +
# chmod 640 /etc/webapps/gitlab/secret
  
 
==See also==
 
==See also==
*[https://github.com/gitlabhq/gitlabhq/blob/stable/doc/install/installation.md Official Documentation]
+
*[https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md Official Documentation]
*[https://github.com/gitlabhq/gitlab-recipes Gitlab recipes for setup on different platforms, update etc.]
+
*[https://gitlab.com/gitlab-org/gitlab-recipes Gitlab recipes with further documentation on running it with several webservers]
*[http://www.andmarios.com/en/2012/06/gitlab-on-an-ubuntu-10-04-server-with-apache/ GitLab on an Ubuntu 10.04 server with Apache]
+
*[https://github.com/gitlabhq/gitlabhq GitLab source code]
*[http://blog.phusion.nl/2012/04/21/tutorial-setting-up-gitlab-on-debian-6/ Setting up gitlab on Debian 6]
 
*[http://howto.basjes.nl/linux/installing-gitlab-on-centos-6 Installing Gitlab on CentOS 6]
 
*[https://gist.github.com/2440768 Gist: Install Gitlab on Debian Squeeze]
 
*[https://gist.github.com/3305554 Gist: Install Gitlab on Archlinux]
 

Latest revision as of 12:17, 8 March 2017

Related articles

From GitLab's homepage:

GitLab offers git repository management, code reviews, issue tracking, activity feeds and wikis. Enterprises install GitLab on-premise and connect it with LDAP and Active Directory servers for secure authentication and authorization. A single GitLab server can handle more than 25,000 users but it is also possible to create a high availability setup with multiple active servers.

An example live version can be found at GitLab.com.

Installation

Note: If you want to use RVM refer to the article #Running GitLab with rvm before starting with the installation
Note: This article covers installing and configuring GitLab without HTTPS at first. If needed, see #Advanced Configuration to set up SSL

GitLab requires Redis and a database backend. If you plan to run it on the same machine, first install either MySQL or PostgreSQL.

Install the gitlab package.

In order to receive mail notifications, a mail server must be installed and configured. See the following for more information: Category:Mail server

Configuration

Notes Before Configuring

The gitlab package installs GitLab's files in a manner that more closely follows standard Linux conventions:

Description GitLab's Official gitlab
Configuration File GitShell /home/git/gitlab-shell/config.yml /etc/webapps/gitlab-shell/config.yml
Configuration File GitLab /home/git/gitlab/config/gitlab.yml /etc/webapps/gitlab/gitlab.yml
User (Home Directory) git (/home/git) gitlab (/var/lib/gitlab)
Tip: If you are familiar with the Arch Build System you can edit the PKGBUILD and relevant files to change gitlab's home directory to a place of your liking.

Basic configuration

GitLab

Edit /etc/webapps/gitlab/gitlab.yml and setup at least the following parameters:

Tip: The hostname and port are used for the git clone http://hostname:port as example.

Hostname: In the gitlab: section set host: - replacing localhost to yourdomain.com (note: no 'http://' or trailing slash) - into your fully qualified domain name.

Port: port: can be confusing. This is not the port that the gitlab server (unicorn) runs on; it's the port that users will initially access through in their browser. Basically, if you intend for users to visit 'yourdomain.com' in their browser, without appending a port number to the domain name, leave port: as 80. If you intend your users to type something like 'yourdomain.com:3425' into their browsers, then you'd set port: to 3425. You will also have to configure your webserver to listen on that port.

Timezone (optional): The time_zone: parameter is optional, but may be useful to force the zone of GitLab applications.

Finally set the correct permissions to the uploads directory:

# chmod 700 /var/lib/gitlab/uploads

GitLab Shell

Tango-view-refresh-red.pngThis article or section is out of date.Tango-view-refresh-red.png

Reason: Configuration variables in this section are no longer in config.yml (Discuss in Talk:Gitlab#)
Note: You can leave the gitlab_url with default value if you intend to host GitLab on the same host.

Edit /etc/webapps/gitlab-shell/config.yml and set gitlab_url: to the prefer url and port:

/etc/webapps/gitlab-shell/config.yml
# GitLab user. git by default
user: gitlab

# Url to gitlab instance. Used for api calls. Should end with a slash.
# Default: http://localhost:8080/
# You only have to change the default if you have configured Unicorn
# to listen on a custom port, or if you have configured Unicorn to
# only listen on a Unix domain socket.
gitlab_url: "http://localhost:8080/" #

http_settings:
#  user: someone
#  password: somepass
...

Update the /etc/webapps/gitlab/unicorn.rb configuration if the port and/or hostname is different from the default:

/etc/webapps/gitlab/unicorn.rb
listen "/run/gitlab/gitlab.socket", :backlog => 1024
listen "127.0.0.1:8080", :tcp_nopush => true

Redis

Using a Redis setup different from default (e.g. different address, port, unix socket) requires the environment variable REDIS_URL to be set accordingly for unicorn. This can be achieved by extending the systemd service file. Create a file /etc/systemd/system/gitlab-unicorn.service.d/redis.conf that injects the REDIS_URL environment variable:

[Service]
Environment=REDIS_URL=unix:///run/gitlab/redis.sock
Enable listen on socket

Follow instructions describe on Redis#Listen on socket, and adjust the default configuration [1].

  • Add the user git and gitlab to the redis group.
  • Update the configuration files:
/etc/webapps/gitlab/resque.yml
development: unix:/var/run/redis/redis.sock
test: unix:/run/redis/redis.sock
production: unix:/run/redis/redis.sock
/etc/webapps/gitlab-shell/config.yml
# Redis settings used for pushing commit notices to gitlab
redis:
  bin: /usr/bin/redis-cli
  host: 127.0.0.1
  port: 6379
  # pass: redispass # Allows you to specify the password for Redis
  database: 5 # Use different database, default up to 16
  socket: /var/run/redis/redis.sock # uncomment this line
  namespace: resque:gitlab

Further configuration

Database backend

A Database backend will be required before Gitlab can be run. Currently GitLab supports MariaDB and PostgreSQL. By default, GitLab assumes you will use MySQL. Extra work is needed if you plan to use PostgreSQL.

MariaDB

To set up MySQL (MariaDB) you need to create a database called gitlabhq_production along with a user (default: gitlab) who has full privileges to the database:

$ mysql -u root -p
mysql> CREATE DATABASE `gitlabhq_production` DEFAULT CHARACTER SET `utf8` COLLATE `utf8_unicode_ci`;
mysql> CREATE USER 'gitlab'@'localhost' IDENTIFIED BY 'password';
mysql> GRANT ALL ON `gitlabhq_production`.* TO 'gitlab'@'localhost';
mysql> \q

Try connecting to the new database with the new user:

$ mysql -u gitlab -p -D gitlabhq_production

Copy the MySQL template file before configuring it:

# cp /usr/share/doc/gitlab/database.yml.mysql /etc/webapps/gitlab/database.yml

Next you will need to open /etc/webapps/gitlab/database.yml and set username: and password: for the gitlabhq_production:

/etc/webapps/gitlab/database.yml
#
# PRODUCTION
#
production:
  adapter: mysql2
  encoding: utf8
  collation: utf8_general_ci
  reconnect: false
  database: gitlabhq_production
  pool: 10
  username: username
  password: "password"
  # host: localhost
  # socket: /var/run/mysqld/mysqld.sock # If running MariaDB as socket
...

It should not be set as world readable, e.g. only processes running under the gitlab user should have read/write access:

# chmod 600 /etc/webapps/gitlab/database.yml
# chown gitlab:gitlab /etc/webapps/gitlab/database.yml

For more info and other ways to create/manage MySQL databases, see the MariaDB documentation and the GitLab official (generic) install guide.

PostgreSQL

Login to PostgreSQL and create the gitlabhq_production database with along with it's user. Remember to change your_username_here and your_password_here to the real values:

# psql -d template1
template1=# CREATE USER your_username_here WITH PASSWORD 'your_password_here';
template1=# ALTER USER your_username_here SUPERUSER;
template1=# CREATE DATABASE gitlabhq_production OWNER your_username_here;
template1=# \q
Note: The reason for creating the user as a superuser is that GitLab is trying to be "smart" and install extensions (not just create them in it's own userspace). And this is only allowed by superusers in Postgresql.

Try connecting to the new database with the new user to verify it works:

# psql -d gitlabhq_production

Copy the PostgreSQL template file before configuring it (overwriting the default MySQL configuration file):

# cp /usr/share/doc/gitlab/database.yml.postgresql /etc/webapps/gitlab/database.yml

Open the new /etc/webapps/gitlab/database.yml and set the values for username: and password:. For example:

/etc/webapps/gitlab/database.yml
#
# PRODUCTION
#
production:
  adapter: postgresql
  encoding: unicode
  database: gitlabhq_production
  pool: 10
  username: your_username_here
  password: "your_password_here"
  # host: localhost
  # port: 5432
  # socket: /tmp/postgresql.sock
...

For our purposes (unless you know what you are doing), you do not need to worry about configuring the other databases listed in /etc/webapps/gitlab/database.yml. We only need to set up the production database to get GitLab working.

Firewall

If you want to give direct access to your Gitlab installation through an iptables firewall, you may need to adjust the port and the network address:

# iptables -A tcp_inbound -p TCP -s 192.168.1.0/24 --destination-port 80 -j ACCEPT

To enable API-access:

# iptables -A tcp_inbound -p TCP -s 192.168.1.0/24 --destination-port 8080 -j ACCEPT

If you are behind a router, do not forget to forward this port to the running GitLab server host, if you want to allow WAN-access.

Initialize Gitlab database

Start the Redis server before we create the database.

Initialize the database and activate advanced features:

# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake gitlab:setup RAILS_ENV=production"

Finally run the following commands to check your installation:

# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake gitlab:env:info RAILS_ENV=production"
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake gitlab:check RAILS_ENV=production"
Note:
  • The gitlab:env:info and gitlab:check commands will show a fatal error related to git. This is OK.
  • If gitlab:check fails with Check GitLab API access: FAILED. code: 401, see [2] and [3] of the troubleshoot section to resolve this.
  • The gitlab:check will complain about missing initscripts. This is nothing to worry about, as systemd service files are used instead (which GitLab does not recognize).

Configure Git User

# cd /usr/share/webapps/gitlab
# sudo -u gitlab -H git config --global user.name  "GitLab"
# sudo -u gitlab -H git config --global user.email "example@example.com"
# sudo -u gitlab -H git config --global core.autocrlf "input"

Adjust modifier bits

(The gitlab check won't pass if the user and group ownership isn't configured properly)

# chmod -R ug+rwX,o-rwx /var/lib/gitlab/repositories/
# chmod -R ug-s /var/lib/gitlab/repositories
# find /var/lib/gitlab/repositories/ -type d -print0 | xargs -0 chmod g+s

Start and test GitLab

Note: See #Troubleshooting and log files inside the /usr/share/webapps/gitlab/log directory for troubleshooting.

Make sure MySQL or PostgreSQL and Redis are running and setup correctly.

After starting the database backends, we can start GitLab with its webserver (Unicorn) by starting both the gitlab-sidekiq and gitlab-unicorn systemd units.

To automatically launch GitLab at startup, enable the gitlab.target, gitlab-sidekiq and gitlab-unicorn services.

Now test your GitLab instance by visiting http://localhost:8080 or http://yourdomain.com, you should be prompted to create a password:

username: root
password: You'll be prompted to create one on your first visit.

Upgrade database on updates

After updating the gitlab package, it is required to upgrade the database:

# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle-2.3 exec rake db:migrate RAILS_ENV=production"

Afterwards, restart gitlab-related services:

# systemctl daemon-reload
# systemctl restart gitlab-sidekiq gitlab-unicorn gitlab-workhorse

Advanced Configuration

Custom SSH Connection

If you are running SSH on a non-standard port, you must change the GitLab user's SSH config:

/var/lib/gitlab/.ssh/config
host localhost      # Give your setup a name (here: override localhost)
user gitlab         # Your remote git user
port 2222           # Your port number
hostname 127.0.0.1; # Your server name or IP

You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the /etc/webapps/gitlab/gitlab.yml file.

HTTPS/SSL

Change GitLab configs

Modify /etc/webapps/gitlab/shell.yml so the url to your GitLab site starts with https://. Modify /etc/webapps/gitlab/gitlab.yml so that https: setting is set to true.

See also Apache HTTP Server#TLS/SSL and Let’s Encrypt.

Let's Encrypt

To validate your URL, the Let's Encrypt process will try to access your gitlab server with something like https://gitlab.YOUR_SERVER_FQDN/.well-known/acme-challenge/A_LONG_ID. But, due to gitlab configuration, every request to gitlab.YOUR_SERVER_FQDN will be redirected to a proxy (gitlab-workhorse) that will not be able to deal with this URL.

To bypass this issue, you can use the Let's Encrypt webroot configuration, setting the webroot at /srv/http/letsencrypt/.

Additionally, force the Let's Encrypt request for gitlab to be redirected to this webroot by adding the following:

/etc/http/conf/extra/gitlab.conf
Alias "/.well-known"  "/srv/http/letsencrypt/.well-known"
RewriteCond   %{REQUEST_URI}  !/\.well-known/.*

Web server configuration

If you want to integrate Gitlab into a running web server instead of using its build-in http server Unicorn, then follow these instructions.

Node.js

You can easily set up an http proxy on port 443 to proxy traffic to the GitLab application on port 8080 using http-master for Node.js. After you have creates your domain's OpenSSL keys and have gotten you CA certificate (or self signed it), then go to https://github.com/CodeCharmLtd/http-master to learn how easy it is to proxy requests to GitLab using HTTPS. http-master is built on top of node-http-proxy.

Nginx and unicorn

Copy /usr/share/doc/gitlab/nginx.conf.example or /usr/share/doc/gitlab/nginx-ssl.conf.example to /etc/nginx/servers-available/gitlab. See Nginx#Managing server entries for more information.

Update the /etc/nginx/servers-available/gitlab file and restart the nginx service.

If you are unable to authenticate, add the following headers to /etc/nginx/servers-available/gitlab:

proxy_set_header    X-Forwarded-Ssl     on; # Only when using SSL
proxy_set_header    X-Frame-Options     SAMEORIGIN; 
Alternative Example
Note: You may need to change localhost:8080 with the correct gitlab address and example.com to your desired server name.
Tip: See Nginx#TLS/SSL before enabling SSL.

Create a file /etc/nginx/servers-available/gitlab with the following content:

/etc/nginx/servers-available/gitlab
# Created by: Sameer Naik
# Contributor: francoism90
# Source: https://gist.github.com/sameersbn/becd1c976c3dc4866ef8

upstream gitlab-workhorse {
  server unix:/run/gitlab/gitlab-workhorse.socket fail_timeout=0;
}


server {
  listen 80;
  #listen 443 ssl; # uncomment to enable ssl
  keepalive_timeout 70;
  server_name example.com
  server_tokens off;
  #ssl_certificate ssl/example.com.crt;
  #ssl_certificate_key ssl/example.com.key;
  charset utf-8;
  root /dev/null;
  
  # Increase this if you want to upload larger attachments
  client_max_body_size 20m;
  
  location / {
      proxy_read_timeout 300;
      proxy_connect_timeout 300;
      proxy_redirect off;
      
      proxy_set_header X-Forwarded-Proto $scheme;
      proxy_set_header Host $http_host;
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-Ssl on;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header X-Forwarded-Proto $scheme;
      proxy_set_header X-Frame-Options SAMEORIGIN;
      
      proxy_pass http://gitlab-workhorse;
  }  
}

Apache and unicorn

Install apache from the official repositories.

Configure Unicorn

As the official installation guide instructs, copy the unicorn configuration file:

# sudo -u git -H cp /usr/share/webapps/gitlab/config/unicorn.rb.example /usr/share/webapps/gitlab/config/unicorn.rb

Now edit config/unicorn.rb and add a listening port by uncommenting the following line:

listen "127.0.0.1:8080"
Tip: You can set a custom port if you want. Just remember to also include it in Apache's virtual host. See below.
Create a virtual host for Gitlab

Create a configuration file for Gitlab’s virtual host and insert the lines below adjusted accordingly. For the ssl section see LAMP#SSL[broken link: invalid section]. If you do not need it, remove it. Notice that the SSL virtual host needs a specific IP instead of generic. Also if you set a custom port for Unicorn, do not forget to set it at the BalanceMember line.

You can use these examples to get you started.

Enable host and start unicorn

Enable your Gitlab virtual host and reload Apache:

/etc/httpd/conf/httpd.conf
 Include /etc/httpd/conf/extra/gitlab.conf

Copy the Apache gitlab.conf file

# cp /usr/share/doc/gitlab/apache.conf.example /etc/httpd/conf/extra/gitlab.conf

Finally start gitlab-unicorn.service.

Gitlab-workhorse

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: This section needs configuration instructions. (Discuss in Talk:Gitlab#)

Since 8.0 GitLab uses separate HTTP server gitlab-workhorse for large HTTP requests like Git push/pull. If you want to use this instead of SSH, install the gitlab-workhorse package, enable gitlab-workhorse.service and configure web server for this. gitlab-workhorse should now be preferred over gitlab-unicorn according to the GitLab team: https://gitlab.com/gitlab-org/gitlab-ce/issues/22528#note_16036216

Note: Unicorn is still needed so don't disable or stop gitlab-unicorn.service. If you've changed the port Unicorn listens at, edit the -authBackend setting in gitlab-workhorse.service accordingly

By default gitlab-workhorse listens on /run/gitlab/gitlab-workhorse.socket. You can edit gitlab-workhorse.service and change the parameter -listenAddr to make it listen on an address, for example -listenAddr 127.0.0.1:8181. If listening on an address you also need to set the network type to -listenNetwork tcp

When using nginx remember to edit your nginx configuration file. To switch from gitlab-unicorn to gitlab-workhorse edit the two following settings accordingly

/etc/nginx/servers-available/gitlab
upstream gitlab {
   server unix:/run/gitlab/gitlab-workhorse.socket fail_timeout=0;
}

...
      
      proxy_pass http://unix:/run/gitlab/gitlab-workhorse.socket;
  }  
}

Useful Tips

Fix Rake Warning

When running rake tasks for the gitlab project, this error will occur: fatal: Not a git repository (or any of the parent directories): .git. This is a bug in bundler, and it can be safely ignored. However, if you want to git rid of the error, the following method can be used:

# cd /usr/share/webapps/gitlab
# sudo -u gitlab git init
# sudo -u gitlab git commit -m "initial commit" --allow-empty

Hook into /var

# mkdir -m700 /var/log/gitlab /var/tmp/gitlab
# chown gitlab:gitlab /var/log/gitlab /var/tmp/gitlab
# sudo -u gitlab -i
# cd ~/gitlab
# d=log; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d
# d=tmp; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d

Hidden options

Go to Gitlab's home directory:

# cd /usr/share/webapps/gitlab

and run:

# rake -T | grep gitlab
rake gitlab:app:check                         # GITLAB | Check the configuration of the GitLab Rails app
rake gitlab:backup:create                     # GITLAB | Create a backup of the GitLab system
rake gitlab:backup:restore                    # GITLAB | Restore a previously created backup
rake gitlab:check                             # GITLAB | Check the configuration of GitLab and its environment
rake gitlab:cleanup:block_removed_ldap_users  # GITLAB | Cleanup | Block users that have been removed in LDAP
rake gitlab:cleanup:dirs                      # GITLAB | Cleanup | Clean namespaces
rake gitlab:cleanup:repos                     # GITLAB | Cleanup | Clean repositories
rake gitlab:env:check                         # GITLAB | Check the configuration of the environment
rake gitlab:env:info                          # GITLAB | Show information about GitLab and its environment
rake gitlab:generate_docs                     # GITLAB | Generate sdocs for project
rake gitlab:gitlab_shell:check                # GITLAB | Check the configuration of GitLab Shell
rake gitlab:import:all_users_to_all_groups    # GITLAB | Add all users to all groups (admin users are added as owners)
rake gitlab:import:all_users_to_all_projects  # GITLAB | Add all users to all projects (admin users are added as masters)
rake gitlab:import:repos                      # GITLAB | Import bare repositories from gitlab_shell -> repos_path into GitLab project instance
rake gitlab:import:user_to_groups[email]      # GITLAB | Add a specific user to all groups (as a developer)
rake gitlab:import:user_to_projects[email]    # GITLAB | Add a specific user to all projects (as a developer)
rake gitlab:satellites:create                 # GITLAB | Create satellite repos
rake gitlab:setup                             # GITLAB | Setup production application
rake gitlab:shell:build_missing_projects      # GITLAB | Build missing projects
rake gitlab:shell:install[tag,repo]           # GITLAB | Install or upgrade gitlab-shell
rake gitlab:shell:setup                       # GITLAB | Setup gitlab-shell
rake gitlab:sidekiq:check                     # GITLAB | Check the configuration of Sidekiq
rake gitlab:test                              # GITLAB | Run all tests
rake gitlab:web_hook:add                      # GITLAB | Adds a web hook to the projects
rake gitlab:web_hook:list                     # GITLAB | List web hooks
rake gitlab:web_hook:rm                       # GITLAB | Remove a web hook from the projects
rake setup                                    # GITLAB | Setup gitlab db

Backup and restore

Create a backup of the gitlab system:

# sudo -u gitlab -H rake RAILS_ENV=production gitlab:backup:create

Restore the previously created backup file /home/gitlab/gitlab/tmp/backups/20130125_11h35_1359131740_gitlab_backup.tar:

# sudo -u gitlab -H rake RAILS_ENV=production gitlab:backup:restore BACKUP=/home/gitlab/gitlab/tmp/backups/20130125_11h35_1359131740
Note: Backup folder is set in config/gitlab.yml. GitLab backup and restore is documented here.

Migrate from sqlite to mysql

Get latest code as described in #Update Gitlab[broken link: invalid section]. Save data.

# cd /home/gitlab/gitlab
# sudo -u gitlab bundle-2.3 exec rake db:data:dump RAILS_ENV=production

Follow #Mysql[broken link: invalid section] instructions and then setup the database.

# sudo -u gitlab bundle-2.3 exec rake db:setup RAILS_ENV=production

Finally restore old data.

# sudo -u gitlab bundle-2.3 exec rake db:data:load RAILS_ENV=production

Running GitLab with rvm

To run gitlab with rvm first you have to set up an rvm:

 curl -L https://get.rvm.io | bash -s stable --ruby=1.9.3
Note: Version 1.9.3 is currently recommended to avoid some compatibility issues.

For the complete installation you will want to be the final user (e.g. git) so make sure to switch to this user and activate your rvm:

 su - git
 source "$HOME/.rvm/scripts/rvm"

Then continue with the installation instructions from above. However, the systemd scripts will not work this way, because the environment for the rvm is not activated. The recommendation here is to create to separate shell scripts for unicorn and sidekiq to activate the environment and then start the service:

gitlab.sh
#!/bin/sh
source `/home/git/.rvm/bin/rvm 1.9.3 do rvm env --path`
bundle-2.3 exec "unicorn_rails -c /usr/share/webapps/gitlab/config/unicorn.rb -E production"
sidekiq.sh
#!/bin/sh
source `/home/git/.rvm/bin/rvm 1.9.3 do rvm env --path`
case $1 in
    start)
        bundle-2.3 exec rake sidekiq:start RAILS_ENV=production
        ;;
    stop)
        bundle-2.3 exec rake sidekiq:stop RAILS_ENV=production
        ;;
    *)
        echo "Usage $0 {start|stop}"
esac

Then modify the above systemd files so they use these scripts. Modify the given lines:

gitlab.service
ExecStart=/home/git/bin/gitlab.sh
sidekiq.service
ExecStart=/home/git/bin/sidekiq.sh start
ExecStop=/home/git/bin/sidekiq.sh stop

Sending mails from Gitlab via SMTP

You might want to use a gmail (or other mail service) to send mails from your gitlab server. This avoids the need to install a mail daemon on the gitlab server.

Adjust smtp_settings.rb according to your mail server settings:

/usr/share/webapps/gitlab/config/initializers/smtp_settings.rb
if Rails.env.production?
  Gitlab::Application.config.action_mailer.delivery_method = :smtp

  Gitlab::Application.config.action_mailer.smtp_settings = {
    address:              'smtp.gmail.com',
    port:                 587,
    domain:               'gmail.com',
    user_name:            'username@gmail.com',
    password:             'application password',
    authentication:       'plain',
    enable_starttls_auto: true
  }
end

Gmail will reject mails received this way (and send you a mail that it did). You will need to disable secure authentication (follow the link in the rejection mail) to work around this. The more secure approach is to enable two-factor authentication for username@gmail.com and to set up an application password for this configuration file.

Troubleshooting

Sometimes things may not work as expected. Be sure to visit the Trouble Shooting Guide.

HTTPS is not green (gravatar not using https)

Redis caches gravatar images, so if you have visited your GitLab with http, then enabled https, gravatar will load up the non-secure images. You can clear the cache by doing

cd /usr/share/webapps/gitlab
RAILS_ENV=production bundle-2.3 exec rake cache:clear

as the gitlab user.

401 Unauthorized on all API access

Make 100% sure, that the files /etc/webapps/gitlab/secret and /etc/webapps/gitlab-shell/secret files contain something!

Error at push bad line length character: API

If you get the following error while trying to push

fatal: protocol error: bad line length character: API

Check that your /etc/webapps/gitlab-shell/secret matches /usr/share/webapps/gitlab/.gitlab_shell_secret

If it is not the same, recreate the file with the following command

ln -s /etc/webapps/gitlab-shell/secret /usr/share/webapps/gitlab/.gitlab_shell_secret

Errors after updating

After updating the package from the AUR, the database migrations and asset updates will sometimes fail. These steps may resolve the issue, if a simple reboot does not.

First, move to the gitlab installation directory.

# cd /usr/share/webapps/gitlab

If every gitlab page gives a 500 error, then the database migrations and the assets are probably stale. If not, skip this step.

# sudo -u gitlab -H bundle-2.3 exec rake db:migrate RAILS_ENV=production

If gitlab is constantly waiting for the deployment to finish, then the assets have probably not been recompiled.

# sudo -u gitlab -H bundle-2.3 exec rake gitlab:assets:clean gitlab:assets:compile cache:clear RAILS_ENV=production

Finally, restart the gitlab services and test your site.

# systemctl restart gitlab-unicorn gitlab-sidekiq gitlab-workhorse

/etc/webapps/gitlab/secret is empty

This file is usually generated while installing the gitlab-shell and the gitlab packages, but in some cases it may need to be generated manually.

# hexdump -v -n 64 -e '1/1 "%02x"' /dev/urandom > /etc/webapps/gitlab-shell/secret
# chown root:gitlab /etc/webapps/gitlab-shell/secret
# chmod 640 /etc/webapps/gitlab-shell/secret
# hexdump -v -n 64 -e '1/1 "%02x"' /dev/urandom > /etc/webapps/gitlab/secret
# chown root:gitlab /etc/webapps/gitlab/secret
# chmod 640 /etc/webapps/gitlab/secret

See also