Difference between revisions of "Gitlab"

From ArchWiki
Jump to: navigation, search
(systemd support: Fixed systemd service files, gitlab.target makes no sence -> change to multi-user.target)
(Gitlab-workhorse: Improved semantics on the -listenNetwork note.)
 
(370 intermediate revisions by 60 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}}
+
[http://gitlab.org/ Gitlab] is a free git repository management application based on [[Ruby on Rails]]. 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 [http://demo.gitlabhq.com/ here].
+
{{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}}.}}
+
  
==Required packages==
+
From [https://about.gitlab.com/ GitLab's homepage:]
  
Install the packages below as they are needed to proceed further.
+
: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.
  
# pacman -Syu --noconfirm --needed sudo base-devel zlib libyaml openssl gdbm readline ncurses libffi curl git openssh redis libxml2 libxslt icu python2
+
An example live version can be found at [https://gitlab.com/ GitLab.com].
  
{{Note| In order to receive mail notifications, make sure to install a mail server. By default, Archlinux does not ship with one. The recommended mail server is [[postfix]], but you can use others such as [[SSMTP]], [[msmtp]], [[sendmail]], [https://wiki.archlinux.org/index.php/Category:Mail_Server etc].}}
+
== Installation ==
 +
{{Note|If you want to use RVM refer to the article [[#Running GitLab with rvm]] before starting with the installation}}
  
== PKGBUILDs for Gitlab and Gitlab-shell ==
+
{{Note|This article covers installing and configuring GitLab without HTTPS at first. If needed, see [[#Advanced Configuration]] to set up SSL}}
There are some (not fully working) PKGBUILDs available to create installable packages:
+
  
[https://github.com/mtorromeo/archlinux-packages/tree/master/gitlab Gitlab PKGBUILD on GitHub.com]
+
GitLab requires [[Redis]] and a database backend. If you plan to run it on the same machine, first install either [[MySQL]] or [[PostgreSQL]].
  
[https://github.com/mtorromeo/archlinux-packages/tree/master/gitlab-shell Gitlab-shell PKGBUILD on GitHub.com]
+
[[Install]] the {{pkg|gitlab}} package.
  
(Please extend/rename this section with further instructions)
+
In order to receive mail notifications, a mail server must be installed and configured. See the following for more information: [[:Category:Mail server]]
  
==Ruby==
+
== Configuration ==
  
GitLab supports [[ruby]] >= {{ic|1.9.3}} and {{ic|2.0.0}}, but some dependencies gems work better with ruby {{ic|1.9.3}}. Install it from the official repositories and if you bump into any trouble use [[rvm]] with latest ruby {{ic|1.9.3}}.
+
=== Notes Before Configuring ===
 +
The {{pkg|gitlab}} package installs GitLab's files in a manner that more closely follows standard Linux conventions:
  
{{Note|If you want to use rvm be sure to check out [[Gitlab#Running GitLab with rvm]] before starting with the installation}}
+
{| class="wikitable"
 +
! Description
 +
! [https://github.com/gitlabhq/gitlabhq/blob/6-5-stable/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}})
 +
|}
  
==User accounts==
+
{{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.}}
  
Add {{ic|git}} user:
+
===Basic configuration===
  
# useradd -U -m -d /home/git git
+
====GitLab====
 +
Edit {{ic|/etc/webapps/gitlab/gitlab.yml}} and setup at least the following parameters:
  
{{Note| {{ic|git}} user must have its initial group set to {{ic|git}} (not {{ic|users}}). If the initial group is not {{ic|git}}, then all files created by the {{ic|git}} user will be owned by {{ic|git:users}} which will prevent GitLab from showing you a newly created repository (it will get stucked at the page where it tells you how to push to the new repository).}}
+
{{Tip|The hostname and port are used for the {{ic|git clone http://hostname:port}} as example.}}
  
==gitlab-shell==
+
'''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.
  
GitLab Shell is an ssh access and repository management software developed specially for GitLab.
+
'''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.
  
Login as git:
+
'''Timezone (optional):''' The {{ic|time_zone:}} parameter is optional, but may be useful to force the zone of GitLab applications.
+
# su - git
+
  
Clone gitlab shell:
+
Finally set the correct permissions to the ''uploads'' directory:
+
$ git clone https://github.com/gitlabhq/gitlab-shell.git
+
$ cd gitlab-shell
+
  
Switch to the right version:
+
# chmod 700 /var/lib/gitlab/uploads
  
$ git checkout v1.4.0
+
====GitLab Shell====
 +
{{Note|You can leave the {{ic|gitlab_url}} with default value if you intend to host GitLab on the same host.}}
  
Edit {{ic|config.yml}} and replace gitlab_url with something like {{ic|http://domain.com/}}:
+
Edit {{ic|/etc/webapps/gitlab-shell/config.yml}} and set {{ic|gitlab_url:}} to the prefer url and port:
 +
{{hc|/etc/webapps/gitlab-shell/config.yml|2=
 +
# GitLab user. git by default
 +
user: gitlab
  
$ cp config.yml.example config.yml
+
# 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/" #
  
Setup the environment:
+
http_settings:
 +
#  user: someone
 +
#  password: somepass
 +
...
 +
}}
  
$ ./bin/install
+
Update the {{ic|/etc/webapps/gitlab/unicorn.rb}} configuration if the port and/or hostname is different from the default:
 +
{{hc|/etc/webapps/gitlab/unicorn.rb|2=
 +
listen "/run/gitlab/gitlab.socket", :backlog => 1024
 +
listen "'''127.0.0.1:8080'''", :tcp_nopush => true
 +
}}
  
You should see this result:
+
====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
  
{{hc|Example output|<nowiki>
+
=====Enable listen on socket=====
mkdir -p /home/git/repositories: true
+
mkdir -p /home/git/.ssh: true
+
chmod 700 /home/git/.ssh: true
+
touch /home/git/.ssh/authorized_keys: true
+
chmod 600 /home/git/.ssh/authorized_keys: true
+
chmod -R ug+rwX,o-rwx /home/git/repositories: true
+
find /home/git/repositories -type d -print0 | xargs -0 chmod g+s: true
+
</nowiki>}}
+
  
==Database selection==
+
Follow instructions describe on [[Redis#Listen on socket]], and adjust the default configuration [https://github.com/gitlabhq/gitlabhq/issues/6100].
  
Currently GitLab supports [[MySQL]] and [[PostgreSQL]]. [[MariaDB]] has not been officially tested but it works just fine.
+
* Add the user ''git'' and ''gitlab'' to the ''redis'' [[group]].
  
===MariaDB===
+
* Update the configuration files:
 +
{{hc|/etc/webapps/gitlab/resque.yml|2=
 +
development: unix:/var/run/redis/redis.sock
 +
test: unix:/run/redis/redis.sock
 +
production: unix:/run/redis/redis.sock
 +
}}
  
[[pacman|Install]] {{Pkg|mariadb}} and {{Pkg|libmariadbclient}} 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.
+
{{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
 +
}}
  
# su - git
+
=== Further configuration ===
$ mysql -u root -p
+
  
mysql> CREATE DATABASE IF NOT EXISTS `gitlabhq_production` DEFAULT CHARACTER SET `utf8` COLLATE `utf8_unicode_ci`;
+
==== Database backend ====
mysql> CREATE USER 'gitlab'@'localhost' IDENTIFIED BY 'your_password_here';
+
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.
mysql> GRANT SELECT, LOCK TABLES, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER ON `gitlabhq_production`.* TO 'gitlab'@'localhost';
+
mysql> \q
+
  
Try connecting to the new database with the new user:
+
==== MariaDB ====
 +
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:
  
$ mysql -u gitlab -p -D gitlabhq_production
+
{{hc|$ mysql -u root -p|2=
 
+
mysql> CREATE DATABASE `gitlabhq_production` DEFAULT CHARACTER SET `utf8` COLLATE `utf8_unicode_ci`;
===PostgreSQL===
+
mysql> CREATE USER 'gitlab'@'localhost' IDENTIFIED BY 'password';
 
+
mysql> GRANT ALL ON `gitlabhq_production`.* TO 'gitlab'@'localhost';
[[pacman|Install]] {{Pkg|postgresql}} and {{Pkg|libpqxx}} from the [[official repositories]]. Follow [[PostgreSQL#Installing_PostgreSQL]] to set it up and start the [[daemon]].
+
mysql> \q
 
+
}}
Login to PostgreSQL and remember to change {{ic|your_password_here}} to a real one:
+
 
+
# sudo -u postgres psql -d template1
+
 
+
template1=# CREATE USER git WITH PASSWORD 'your_password_here';
+
template1=# CREATE DATABASE gitlabhq_production OWNER git;
+
template1=# \q
+
  
 
Try connecting to the new database with the new user:
 
Try connecting to the new database with the new user:
  
  # sudo -u git -H psql -d gitlabhq_production
+
  $ mysql -u '''gitlab''' -p -D gitlabhq_production
  
===MySQL===
+
Copy the MySQL template file before configuring it:
  
If you are still in favor of {{AUR|mysql}}, follow the same commands as MariaDB.
+
# cp /usr/share/doc/gitlab/database.yml.mysql /etc/webapps/gitlab/database.yml
  
==Gitlab==
+
Next you will need to open {{ic|/etc/webapps/gitlab/database.yml}} and set {{ic|username:}} and {{ic|password:}} for the {{ic|gitlabhq_production}}:
  
===Installation===
+
{{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
 +
...
 +
}}
  
Clone GitLab's repository:
+
It should not be set as world readable, e.g. only processes running under the {{ic|gitlab}} user should have read/write access:
# su - git
+
$ git clone https://github.com/gitlabhq/gitlabhq.git gitlab
+
$ cd gitlab
+
$ git checkout 5-2-stable
+
  
{{Note| You can change {{ic|5-2-stable}} to {{ic|master}} if you want the bleeding edge version, but do so with caution! Check github to see what is the latest stable version and replace above accordingly.}}
+
# chmod 600 /etc/webapps/gitlab/database.yml
 +
# chown gitlab:gitlab /etc/webapps/gitlab/database.yml
  
===Basic configuration===
+
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].
  
First we need to rename the example file.
+
==== 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:
  
  $ cp config/gitlab.yml.example config/gitlab.yml
+
  # psql -d template1
  
The options are pretty straightforward. Open {{ic|config/gitlab.yml}} with your favorite editor and edit where needed.
+
{{bc|1=
Make sure to change {{ic|localhost}} to the fully-qualified domain name of your host serving GitLab where necessary.
+
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
 +
}}
  
Make sure GitLab can write to the {{ic|log/}} and {{ic|tmp/}} directories:
+
{{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.}}
  
$ chown -R git log/
+
Try connecting to the new database with the new user to verify it works:
$ chown -R git tmp/
+
$ chmod -R u+rwX  log/
+
$ chmod -R u+rwX  tmp/
+
  
Create directory for satellites:
+
  # psql -d gitlabhq_production
   
+
$ mkdir /home/git/gitlab-satellites
+
  
Create directories for sockets/pids and make sure GitLab can write to them:
+
Copy the PostgreSQL template file before configuring it (overwriting the default MySQL configuration file):
  
  $ mkdir tmp/{pids,sockets}
+
  # cp /usr/share/doc/gitlab/database.yml.postgresql /etc/webapps/gitlab/database.yml
$ chmod -R u+rwX  tmp/{pids,sockets}
+
  
Create the {{ic|public/uploads}} directory otherwise backup will fail:
+
Open the new {{ic|/etc/webapps/gitlab/database.yml}} and set the values for {{ic|username:}} and {{ic|password:}}. For example:
  
$ mkdir public/uploads
+
{{hc|/etc/webapps/gitlab/database.yml|
$ chmod -R u+rwX  public/uploads
+
#
 +
# 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
 +
...
 +
}}
  
Copy the example Puma config and edit to your liking:
+
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.
  
$ cp config/puma.rb.example config/puma.rb
+
==== Firewall ====
  
Configure Git global settings for git user, useful when editing via web. Edit {{ic|user.email}} according to what is set in {{ic|gitlab.yml}}:
+
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:
  
  $ git config --global user.name "GitLab"
+
  # iptables -A tcp_inbound -p TCP -s '''192.168.1.0/24''' --destination-port '''80''' -j ACCEPT
$ git config --global user.email "gitlab@localhost"
+
  
Configure GitLab database settings:
+
To enable API-access:
  
* MariaDB:
+
  # iptables -A tcp_inbound -p TCP -s '''192.168.1.0/24''' --destination-port '''8080''' -j ACCEPT
  $ cp config/database.yml.mysql config/database.yml
+
  
* PostgreSQL:
+
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.
$ cp config/database.yml.postgresql config/database.yml
+
  
Make sure to update {{ic|username}}/{{ic|password}} in {{ic|config/database.yml}}.
+
==== Initialize Gitlab database ====
  
 +
Start the [[Redis]] server before we create the database.
  
===Install gems===
+
Initialize the database and activate advanced features:
 +
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle exec rake gitlab:setup RAILS_ENV=production"
  
{{Tip| If you do not want to download any gem documentation, add {{ic|gem: --no-rdoc --no-ri}} to {{ic|/home/git/.gemrc}}. Be sure to add it as the {{ic|git}} user in order to acquire the appropriate permissions.}}
+
Finally run the following commands to check your installation:
{{Note|See bug #[https://bugs.archlinux.org/task/33327 33327] for about system-wide gems. As a temporary solution the following packages will be installed as {{ic|git}} user, make sure {{ic|/home/git/.gemrc}} contains {{ic|gem: ... --user-install}}. And then add the {{ic|bin}} path to the {{ic|PATH}} variable like so {{ic|1=export PATH="$PATH:~/.gem/ruby/2.0.0/bin"}}.}}
+
  
Install {{ic|bundler}} and {{ic|charlock_holmes}} under {{ic|/git/home/.gem/}} (normally system wide via sudo):
+
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle exec rake gitlab:env:info RAILS_ENV=production"
 +
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle exec rake gitlab:check RAILS_ENV=production"
  
# su - git
+
{{note|
$ gem install charlock_holmes --version '0.6.9.4'
+
*The ''gitlab:env:info'' and ''gitlab:check'' commands will show a fatal error related to git. This is OK.
$ gem install bundler
+
*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).
 +
}}
  
Install gems from Gemfile:
+
==== 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"
  
$ cd gitlab/
+
==== Adjust modifier bits ====
 +
(The gitlab check won't pass if the user and group ownership isn't configured properly)
  
{{Note|When executing the below and you recieve `Could not verify the SSL certificate for https://rubygems.org/` see bug #[https://github.com/gitlabhq/gitlabhq/issues/4095 GitHub-4095] most likely because you're behind a proxy that tries to inject a local certificate for SSL domains in order to verify its content}}
+
# 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
  
If you used MariaDB:
+
== Start and test GitLab ==
 +
{{note|See [[#Troubleshooting]] and log files inside the {{ic|/usr/share/webapps/gitlab/log}} directory for troubleshooting.}}
  
$ bundle install --deployment --without development test postgres
+
Make sure [[MySQL]] or [[PostgreSQL]] and [[Redis]] are running and setup correctly.
  
If you used PostgreSQL:
+
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.
  
$ bundle install --deployment --without development test mysql
+
To automatically launch GitLab at startup, enable the {{ic|gitlab.target}}, {{ic|gitlab-sidekiq}} and {{ic|gitlab-unicorn}} services.
  
{{Note|1= Using {{ic|--without group_name}} in bundle command line will ignore required packages for the mentioned groups.}}
+
Now test your GitLab instance by visiting http://localhost:8080 or http://yourdomain.com, you should be prompted to create a password:
  
===Initialize Database===
+
{{bc|
 
+
username: root
{{Note| Make sure the redis [[daemon]] is enabled and started, otherwise the following command will fail. To check the status and see if it's running execute {{ic|systemctl status redis}}, if it's dead start it as per usual via {{ic|systemctl start redis}}}}
+
password: You'll be prompted to create one on your first visit.
 
+
}}
Initialize database and activate advanced features:  
+
$ bundle exec rake gitlab:setup RAILS_ENV=production
+
 
+
{{Note|If you recieve a error {{ic|No such file or directory - /home/git/repositories/root}} then most likely you've changed the default configuration for {{ic|GitLab}} and you'll need to modify all static paths in {{ic|config/gitlab.yml}} and run the above command again to initialize the database!}}
+
 
+
===Check status===
+
 
+
With the following commands we check if the steps we followed so far are configured properly.
+
  
$ bundle exec rake gitlab:env:info RAILS_ENV=production
+
== Upgrade database on updates ==
  $ bundle exec rake gitlab:check RAILS_ENV=production
+
After updating the {{Pkg|gitlab}} package, it is required to upgrade the database:
 +
  # su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle exec rake db:migrate RAILS_ENV=production"
  
{{hc|Example output of gitlab:env:info|
+
Afterwards, restart gitlab-related services:
System information
+
# systemctl daemon-reload
System: Arch Linux
+
# systemctl restart gitlab-sidekiq gitlab-unicorn gitlab-workhorse
Current User: git
+
Using RVM: yes
+
RVM Version: 1.20.3
+
Ruby Version: 2.0.0p0
+
Gem Version: 2.0.0
+
Bundler Version:1.3.5
+
Rake Version: 10.0.4
+
  
GitLab information
+
== Advanced Configuration ==
Version: 5.2.0.pre
+
Revision: 4353bab
+
Directory: /home/git/gitlab
+
DB Adapter: mysql2
+
URL: http://gitlab.arch
+
HTTP Clone URL: http://gitlab.arch/some-project.git
+
SSH Clone URL: git@gitlab.arch:some-project.git
+
Using LDAP: no
+
Using Omniauth: no
+
  
GitLab Shell
+
=== Custom SSH Connection ===
Version: 1.4.0
+
If you are running SSH on a non-standard port, you must change the GitLab user's SSH config:
Repositories: /home/git/repositories/
+
{{hc|/var/lib/gitlab/.ssh/config|2=
Hooks: /home/git/gitlab-shell/hooks/
+
host localhost      # Give your setup a name (here: override localhost)
Git: /usr/bin/git
+
user gitlab        # Your remote git user
 +
port 2222          # Your port number
 +
hostname 127.0.0.1; # Your server name or IP
 
}}
 
}}
  
{{Note| {{ic|gitlab:check}} will complain about missing initscripts. Don't worry, we will use ArchLinux' [[systemd]] to manage server start (which GitLab does not recognize).}}
+
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.
  
==Web server configuration==
+
=== HTTPS/SSL ===
  
 +
==== Change GitLab configs ====
 +
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}}.
  
===Unicorn only===
+
See also [[Apache HTTP Server#TLS/SSL]] and [[Let’s Encrypt]].
  
{{Note|As of GitLab 5.1 Unicorn is no longer the default server as it got replaced by Puma. You can therefore ignore this section.}}
+
==== Let's Encrypt ====
  
Edit {{ic|/home/gitlab/gitlab/config/unicorn.rb}} uncomment:
+
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.
  
listen 8080 # listen to port 8080 on all TCP interfaces
+
To bypass this issue, you can use the Let's Encrypt webroot configuration, setting the webroot at {{ic|/srv/http/letsencrypt/}}.
  
Create {{ic|/etc/rc.d/unicorn-gitlab}}.
+
Additionally, force the Let's Encrypt request for gitlab to be redirected to this webroot by adding the following:
<pre>
+
#!/bin/bash
+
  
. /etc/rc.conf
+
{{hc|/etc/http/conf/extra/gitlab.conf|
. /etc/rc.d/functions
+
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.
  
PID=`pidof -o %PPID /usr/bin/ruby`
+
===== Node.js =====
case "$1" in
+
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].
  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''':
+
==== 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.
  
# /etc/rc.d/unicorn-gitlab start
+
Update the {{ic|/etc/nginx/servers-available/gitlab}} file and [[restart]] the nginx service.
  
Test it http://localhost:8080
+
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;
  
Add it to DAEMONS array in /etc/rc.conf
+
===== Alternative Example =====
 +
{{Note|You may need to change {{ic|localhost:8080}} with the correct gitlab address and {{ic|example.com}} to your desired server name.}}
 +
{{Tip|See [[Nginx#TLS.2FSSL|Nginx#TLS/SSL]] before enabling SSL.}}
 +
Create a file {{ic|/etc/nginx/servers-available/gitlab}} with the following content:
  
Redirect http port to unicorn server
+
{{hc|/etc/nginx/servers-available/gitlab|2=
 +
# Created by: Sameer Naik
 +
# Contributor: francoism90
 +
# Source: https://gist.github.com/sameersbn/becd1c976c3dc4866ef8
 +
upstream gitlab {
 +
  server localhost:8080 fail_timeout=0;
 +
}
  
# iptables -A PREROUTING -t nat -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080
+
server {
 
+
  listen 80;
And test again, now http://localhost
+
  #listen 443 ssl; # uncomment to enable ssl
 
+
  keepalive_timeout 70;
===Nginx and unicorn===
+
  server_name example.com
 
+
  server_tokens off;
[[pacman|Install]] {{Pkg|nginx}} from the [[official repositories]].
+
  #ssl_certificate ssl/example.com.crt;
 
+
  #ssl_certificate_key ssl/example.com.key;
Run these commands to setup nginx:
+
  charset utf-8;
 
+
  root /dev/null;
# wget https://raw.github.com/gitlabhq/gitlab-recipes/master/nginx/gitlab -P /etc/nginx/sites-available/
+
 
# ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
+
  # Increase this if you want to upload larger attachments
 
+
  client_max_body_size 20m;
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:
+
 
+
  location / {
# chgrp http /home/gitlab
+
      proxy_read_timeout 300;
# chmod u=rwx,g=rx,o= /home/gitlab
+
      proxy_connect_timeout 300;
 
+
      proxy_redirect off;
Restart gitlab.service, resque.service and nginx.
+
     
 
+
      proxy_set_header X-Forwarded-Proto $scheme;
[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:
+
      proxy_set_header Host $http_host;
 
+
      proxy_set_header X-Real-IP $remote_addr;
# cd /home/gitlab/gitlab
+
      proxy_set_header X-Forwarded-Ssl on;
# sudo -u gitlab cp config/unicorn.rb.orig config/unicorn.rb
+
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  # sudo -u gitlab bundle exec unicorn_rails -c config/unicorn.rb -E production -D
+
      proxy_set_header X-Forwarded-Proto $scheme;
 
+
      proxy_set_header X-Frame-Options SAMEORIGIN;
===Apache and unicorn===
+
     
 +
      proxy_pass http://localhost:8080;
 +
  }  
 +
}
 +
}}
  
[[pacman|Install]] {{Pkg|apache}} from the [[official repositories]].
+
==== Apache and unicorn ====
  
====Configure Unicorn====
+
[[Install]] {{Pkg|apache}} from the [[official repositories]].
  
{{Note|If the default path is not {{ic|/home/git}} for your installation, change the below path accordingly}}
+
=====Configure Unicorn=====
  
 
As the official installation guide instructs, copy the unicorn configuration file:
 
As the official installation guide instructs, copy the unicorn configuration file:
  # sudo -u git -H cp /home/git/gitlab/config/unicorn.rb.example /home/git/gitlab/config/unicorn.rb
+
  # sudo -u git -H cp /usr/share/webapps/gitlab/config/unicorn.rb.example /usr/share/webapps/gitlab/config/unicorn.rb
  
 
Now edit {{ic|config/unicorn.rb}} and add a listening port by uncommenting the following line:
 
Now edit {{ic|config/unicorn.rb}} and add a listening port by uncommenting the following line:
Line 357: Line 390:
 
{{Tip| You can set a custom port if you want. Just remember to also include it in Apache's virtual host. See below.}}
 
{{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 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]]. 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.
+
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.
  
# mkdir -pv /etc/httpd/conf/vhosts/
+
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.
  
{{hc|/etc/httpd/conf/vhosts/gitlab|
+
=====Enable host and start unicorn=====
<VirtualHost *:80>
+
  ServerName gitlab.myserver.com
+
  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>
+
      BalancerMember http://127.0.0.1:8080
+
  </Proxy>
+
 
+
  <Directory /home/gitlab/gitlab/public>
+
    AllowOverride All
+
    Options -MultiViews
+
  </Directory>
+
 
+
  RewriteEngine on
+
  RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
+
  RewriteRule ^/(.*)$ balancer://unicornservers%{REQUEST_URI} [P,QSA,L]
+
 
+
  ProxyPass /uploads !
+
  ProxyPass / balancer://unicornservers/
+
  ProxyPassReverse / balancer://unicornservers/
+
  ProxyPreserveHost on
+
 
+
  <Proxy *>
+
      Order deny,allow
+
      Allow from all
+
  </Proxy>
+
</VirtualHost>
+
 
+
<VirtualHost MY_IP:443>
+
  ServerName gitlab.myserver.com
+
  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>
+
      BalancerMember http://127.0.0.1:8080
+
  </Proxy>
+
 
+
  <Directory /home/gitlab/gitlab/public>
+
    AllowOverride All
+
    Options -MultiViews
+
  </Directory>
+
 
+
  RewriteEngine on
+
  RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
+
  RewriteRule ^/(.*)$ balancer://unicornservers%{REQUEST_URI} [P,QSA,L]
+
 
+
  ProxyPass /uploads !
+
  ProxyPass / balancer://unicornservers/
+
  ProxyPassReverse / balancer://unicornservers/
+
  ProxyPreserveHost on
+
 
+
  <Proxy *>
+
      Order deny,allow
+
      Allow from all
+
  </Proxy>
+
 
+
  SSLEngine on
+
  SSLCertificateFile /home/gitlab/gitlab/ssl.cert
+
  SSLCertificateKeyFile /home/gitlab/gitlab/ssl.key
+
</VirtualHost>
+
}}
+
 
+
====Enable host and start unicorn====
+
  
 
Enable your Gitlab virtual host and reload [[Apache]]:
 
Enable your Gitlab virtual host and reload [[Apache]]:
{{hc|/etc/httpd/conf/httpd.conf|Include conf/vhosts/gitlab}}
+
{{hc|/etc/httpd/conf/httpd.conf| Include /etc/httpd/conf/extra/gitlab.conf}}
  
Finally start unicorn:
+
Copy the Apache  gitlab.conf file
  
  # cd /home/gitlab/gitlab
+
  # cp /usr/share/doc/gitlab/apache.conf.example /etc/httpd/conf/extra/gitlab.conf
# sudo -u gitlab bundle exec unicorn_rails -c config/unicorn.rb -E production -D
+
  
==systemd support==
+
Finally [[start]] {{ic|gitlab-unicorn.service}}.
  
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.
+
=== Gitlab-workhorse ===
  
Create:
+
{{Expansion|This section needs configuration instructions.}}
{{hc|gitlab.service|<nowiki>
+
  
[Unit]
+
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
Description=GitLab Puma Server
+
  
[Service]
+
{{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}}
User=git
+
WorkingDirectory=/home/git/gitlab
+
Environment=RAILS_ENV=production
+
SyslogIdentifier=gitlab-puma
+
Type=forking
+
TimeoutStartSec=600
+
PIDFile=/home/git/gitlab/tmp/pids/puma.pid
+
  
ExecStart=/usr/bin/bundle exec "puma -C /home/git/gitlab/config/puma.rb -e production"
+
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}}
ExecReload=/bin/kill -HUP $MAINPID
+
ExecStop=/bin/kill -QUIT $MAINPID
+
  
 +
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;
 +
}
  
[Install]
+
...
WantedBy=multi-user.target
+
     
</nowiki>
+
      proxy_pass http://unix:/run/gitlab/gitlab-workhorse.socket;
 +
  } 
 +
}
 
}}
 
}}
  
{{hc|gitlab-sidekiq.service|<nowiki>
+
==Useful Tips==
[Unit]
+
Description=GitLab Sidekiq Server
+
  
[Service]
+
===Fix Rake Warning===
User=git
+
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:
WorkingDirectory=/home/git/gitlab
+
Environment=RAILS_ENV=production
+
SyslogIdentifier=gitlab-sidekiq
+
Type=forking
+
PIDFile=/home/git/gitlab/tmp/pids/sidekiq.pid
+
  
 
+
{{bc|1=
ExecStart=/usr/bin/bundle exec rake sidekiq:start
+
# cd /usr/share/webapps/gitlab
ExecStop=/usr/bin/bundle exec rake sidekiq:stop
+
# sudo -u gitlab git init
 
+
# sudo -u gitlab git commit -m "initial commit" --allow-empty
[Install]
+
WantedBy=multi-user.target</nowiki>
+
 
}}
 
}}
  
Also see: https://github.com/gitlabhq/gitlab-recipes/issues/14
 
 
==Useful Tips==
 
 
===Hook into /var===
 
===Hook into /var===
  sudo mkdir -m700 /var/log/gitlab /var/tmp/gitlab
+
{{bc|1=
  sudo chown gitlab:gitlab /var/log/gitlab /var/tmp/gitlab
+
# mkdir -m700 /var/log/gitlab /var/tmp/gitlab
  sudo -u gitlab -i
+
# chown gitlab:gitlab /var/log/gitlab /var/tmp/gitlab
  cd ~/gitlab
+
# sudo -u gitlab -i
  d=log; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d
+
# cd ~/gitlab
  d=tmp; mv $d/* /var/$d/gitlab; rm -f $d/.gitkeep; rm -r $d && ln -s /var/$d/gitlab $d
+
# 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===
 
===Hidden options===
Go to Gitlab's home directory
+
Go to Gitlab's home directory:
  # cd /home/gitlab/gitlab
+
  # cd /usr/share/webapps/gitlab
  
and run
+
and run:
# rake -T | grep gitlab
+
{{hc|<nowiki># rake -T | grep gitlab</nowiki>|<nowiki>
 
+
rake gitlab:app:check                        # GITLAB | Check the configuration of the GitLab Rails app
These are the options so far:
+
rake gitlab:backup:create                    # GITLAB | Create a backup of the GitLab system
rake gitlab:app:backup_create      # GITLAB | Create a backup of the gitlab system
+
rake gitlab:backup:restore                    # GITLAB | Restore a previously created backup
rake gitlab:app:backup_restore    # GITLAB | Restore a previously created backup
+
rake gitlab:check                            # GITLAB | Check the configuration of GitLab and its environment
  rake gitlab:app:enable_automerge  # GITLAB | Enable auto merge
+
rake gitlab:cleanup:block_removed_ldap_users # GITLAB | Cleanup | Block users that have been removed in LDAP
  rake gitlab:app:setup             # GITLAB | Setup production application
+
rake gitlab:cleanup:dirs                      # GITLAB | Cleanup | Clean namespaces
rake gitlab:app:status            # GITLAB | Check gitlab installation status
+
rake gitlab:cleanup:repos                    # GITLAB | Cleanup | Clean repositories
rake gitlab:gitolite:update_hooks  # GITLAB | Rewrite hooks for repos
+
rake gitlab:env:check                        # GITLAB | Check the configuration of the environment
rake gitlab:gitolite:update_keys  # GITLAB | Rebuild each key at gitolite config
+
rake gitlab:env:info                          # GITLAB | Show information about GitLab and its environment
rake gitlab:gitolite:update_repos  # GITLAB | Rebuild each project at gitolite config
+
rake gitlab:generate_docs                    # GITLAB | Generate sdocs for project
rake gitlab:test                   # GITLAB | Run both cucumber & rspec
+
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>}}
  
 
===Backup and restore===
 
===Backup and restore===
Line 528: Line 495:
  
 
{{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].}}
 
{{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].}}
 
===Update Gitlab===
 
 
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.
 
  
 
===Migrate from sqlite to mysql===
 
===Migrate from sqlite to mysql===
  
Get latest code as described in [[#Update_Gitlab]].
+
Get latest code as described in [[#Update Gitlab]]{{Broken section link}}.
 
Save data.
 
Save data.
 
  # cd /home/gitlab/gitlab
 
  # cd /home/gitlab/gitlab
 
  # sudo -u gitlab bundle exec rake db:data:dump RAILS_ENV=production
 
  # sudo -u gitlab bundle exec rake db:data:dump RAILS_ENV=production
  
Follow [[#Mysql]] instructions and then setup the database.
+
Follow [[#Mysql]]{{Broken section link}} instructions and then setup the database.
 
  # sudo -u gitlab bundle exec rake db:setup RAILS_ENV=production
 
  # sudo -u gitlab bundle exec rake db:setup RAILS_ENV=production
  
Line 559: Line 522:
 
   source "$HOME/.rvm/scripts/rvm"
 
   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 {{ic|puma}} and {{ic|sidekiq}} to activate the environment and then start the service:
+
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:
  
 
{{hc|gitlab.sh|<nowiki>
 
{{hc|gitlab.sh|<nowiki>
 
#!/bin/sh
 
#!/bin/sh
 
source `/home/git/.rvm/bin/rvm 1.9.3 do rvm env --path`
 
source `/home/git/.rvm/bin/rvm 1.9.3 do rvm env --path`
RAILS_ENV=production bundle exec puma -C "/home/git/gitlab/config/puma.rb"</nowiki>
+
bundle exec "unicorn_rails -c /usr/share/webapps/gitlab/config/unicorn.rb -E production"</nowiki>
 
}}
 
}}
  
Line 591: Line 554:
 
ExecStop=/home/git/bin/sidekiq.sh stop
 
ExecStop=/home/git/bin/sidekiq.sh stop
 
</nowiki>}}
 
</nowiki>}}
 +
 +
===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 {{ic|smtp_settings.rb}} according to your mail server settings:
 +
 +
{{hc|/usr/share/webapps/gitlab/config/initializers/smtp_settings.rb|<nowiki>
 +
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</nowiki>}}
 +
 +
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==
 
==Troubleshooting==
  
 
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].
 
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].
 +
 +
=== 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 exec rake cache:clear
 +
 +
as the gitlab user.
 +
 +
=== 401 Unauthorized on all API access ===
 +
Make 100% sure, that the files {{ic|/etc/webapps/gitlab/secret}} and {{ic|/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 {{ic|/etc/webapps/gitlab-shell/secret}} matches {{ic|/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 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 exec rake assets:clean assets:precompile 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 {{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
 +
 +
# 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 09:33, 2 December 2016

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

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 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 exec rake gitlab:env:info RAILS_ENV=production"
# su - gitlab -s /bin/sh -c "cd '/usr/share/webapps/gitlab'; bundle 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 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 {
  server localhost:8080 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://localhost:8080;
  }  
}

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 exec rake db:data:dump RAILS_ENV=production

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

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

Finally restore old data.

# sudo -u gitlab bundle 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 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 exec rake sidekiq:start RAILS_ENV=production
        ;;
    stop)
        bundle 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 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 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 exec rake assets:clean assets:precompile 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