installation.md 34.5 KB
Newer Older
1 2 3 4
---
type: howto
---

5
# Installation from source
Marin Jankovski's avatar
Marin Jankovski committed
6

7 8
This is the official installation guide to set up a production GitLab server
using the source files. To set up a **development installation** or for many
9
other installation options, see the [main installation page](README.md).
10 11 12
It was created for and tested on **Debian/Ubuntu** operating systems.
Read [requirements.md](requirements.md) for hardware and operating system requirements.
If you want to install on RHEL/CentOS, we recommend using the
13
[Omnibus packages](https://about.gitlab.com/install/).
14 15 16 17 18 19 20 21 22 23

This guide is long because it covers many cases and includes all commands you
need, this is [one of the few installation scripts that actually works out of the box](https://twitter.com/robinvdvleuten/status/424163226532986880).
The following steps have been known to work. **Use caution when you deviate**
from this guide. Make sure you don't violate any assumptions GitLab makes about
its environment. For example, many people run into permission problems because
they changed the location of directories or run services as the wrong user.

If you find a bug/error in this guide, **submit a merge request**
following the
24
[contributing guide](https://gitlab.com/gitlab-org/gitlab/blob/master/CONTRIBUTING.md).
25

26 27
## Consider the Omnibus package installation

28
Since an installation from source is a lot of work and error prone we strongly recommend the fast and reliable [Omnibus package installation](https://about.gitlab.com/install/) (deb/rpm).
29

30
One reason the Omnibus package is more reliable is its use of runit to restart any of the GitLab processes in case one crashes.
31
On heavily used GitLab instances the memory usage of the Sidekiq background worker will grow over time.
32 33

Omnibus packages solve this by [letting the Sidekiq terminate gracefully](../administration/operations/sidekiq_memory_killer.md) if it uses too much memory.
34 35
After this termination runit will detect Sidekiq is not running and will start it.
Since installations from source don't use runit for process supervision, Sidekiq
36
can't be terminated and its memory usage will grow over time.
37

38
## Select version to install
39

40
Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install (e.g., `11-7-stable`).
41
You can select the branch in the version dropdown in the top left corner of GitLab (below the menu bar).
42

43
If the highest number stable branch is unclear, check the [GitLab blog](https://about.gitlab.com/blog/) for installation guide links by version.
44

45
## GitLab directory structure
Valery Sizov's avatar
Valery Sizov committed
46

47 48
This is the main directory structure you will end up with following the instructions
of this page:
49

50 51 52 53 54 55 56 57
```
|-- home
|   |-- git
|       |-- .ssh
|       |-- gitlab
|       |-- gitlab-shell
|       |-- repositories
```
58

59
- `/home/git/.ssh` - Contains OpenSSH settings. Specifically the `authorized_keys`
60
  file managed by GitLab Shell.
61 62 63 64
- `/home/git/gitlab` - GitLab core software.
- `/home/git/gitlab-shell` - Core add-on component of GitLab. Maintains SSH
  cloning and other functionality.
- `/home/git/repositories` - Bare repositories for all projects organized by
65
  namespace. This is where the Git repositories which are pushed/pulled are
66 67
  maintained for all projects. **This area contains critical data for projects.
  [Keep a backup](../raketasks/backup_restore.md).**
68

69 70
NOTE: **Note:**
The default locations for repositories can be configured in `config/gitlab.yml`
71
of GitLab and `config.yml` of GitLab Shell.
72

73
For a more in-depth overview, see the [GitLab architecture doc](../development/architecture.md).
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
74

75
## Overview
Valery Sizov's avatar
Valery Sizov committed
76

77
The GitLab installation consists of setting up the following components:
78

79 80 81 82 83 84 85 86
1. [Packages and dependencies](#1-packages-and-dependencies).
1. [Ruby](#2-ruby).
1. [Go](#3-go).
1. [Node](#4-node).
1. [System users](#5-system-users).
1. [Database](#6-database).
1. [Redis](#7-redis).
1. [GitLab](#8-gitlab).
87
1. [NGINX](#9-nginx).
Valery Sizov's avatar
Valery Sizov committed
88

89
## 1. Packages and dependencies
Valery Sizov's avatar
Valery Sizov committed
90

91 92
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
93

94 95 96 97 98 99
```sh
# run as root!
apt-get update -y
apt-get upgrade -y
apt-get install sudo -y
```
Valery Sizov's avatar
Valery Sizov committed
100

101 102
NOTE: **Note:**
During this installation, some files will need to be edited manually. If you are familiar with vim, set it as default editor with the commands below. If you are not familiar with vim, skip this and keep using the default editor.
103

104 105 106 107 108
```sh
# Install vim and set as default editor
sudo apt-get install -y vim
sudo update-alternatives --set editor /usr/bin/vim.basic
```
109

dosire's avatar
dosire committed
110
Install the required packages (needed to compile Ruby and native extensions to Ruby gems):
111

112 113 114
```sh
sudo apt-get install -y build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libre2-dev \
  libreadline-dev libncurses5-dev libffi-dev curl openssh-server checkinstall libxml2-dev \
115 116
  libxslt-dev libcurl4-openssl-dev libicu-dev logrotate rsync python-docutils pkg-config cmake \
  runit
117
```
118

119 120 121
Ubuntu 14.04 (Trusty Tahr) doesn't have the `libre2-dev` package available, but
you can [install re2 manually](https://github.com/google/re2/wiki/Install).

122
If you want to use Kerberos for user authentication, install `libkrb5-dev`:
123

124 125 126
```sh
sudo apt-get install libkrb5-dev
```
127

128 129
NOTE: **Note:**
If you don't know what Kerberos is, you can assume you don't need it.
130

131
Make sure you have the right version of Git installed:
132

133 134 135
```sh
# Install Git
sudo apt-get install -y git-core
136

137
# Make sure Git is version 2.22.0 or higher
138 139
git --version
```
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154
Starting with GitLab 12.0, Git is required to be compiled with `libpcre2`.
Find out if that's the case:

```sh
ldd /usr/local/bin/git | grep pcre2
```

The output should be similar to:

```
libpcre2-8.so.0 => /usr/lib/libpcre2-8.so.0 (0x00007f08461c3000)
```

Is the system packaged Git too old, or not compiled with pcre2? Remove it and compile from source:
155

156 157 158
```sh
# Remove packaged Git
sudo apt-get remove git-core
159

160 161
# Install dependencies
sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential
162

163 164 165 166 167 168 169
# Download and compile pcre2 from source
curl --silent --show-error --location https://ftp.pcre.org/pub/pcre/pcre2-10.33.tar.gz --output pcre2.tar.gz
tar -xzf pcre2.tar.gz
cd pcre2-10.33
chmod +x configure
./configure --prefix=/usr --enable-jit
make
Kyohei Uemura's avatar
Kyohei Uemura committed
170
sudo make install
171

172 173
# Download and compile from source
cd /tmp
174
curl --remote-name --location --progress https://www.kernel.org/pub/software/scm/git/git-2.22.0.tar.gz
Alexander Oleynikov's avatar
Alexander Oleynikov committed
175
echo 'a4b7e4365bee43caa12a38d646d2c93743d755d1cea5eab448ffb40906c9da0b  git-2.22.0.tar.gz' | shasum -a256 -c - && tar -xzf git-2.22.0.tar.gz
176
cd git-2.22.0/
177
./configure --with-libpcre
178
make prefix=/usr/local all
179

180 181
# Install into /usr/local/bin
sudo make prefix=/usr/local install
182

183 184
# When editing config/gitlab.yml (Step 5), change the git -> bin_path to /usr/local/bin/git
```
185

186
For the [Custom Favicon](../user/admin_area/appearance.md#favicon) to work, GraphicsMagick
187 188 189 190 191 192
needs to be installed.

```sh
sudo apt-get install -y graphicsmagick
```

193
**Note:** In order to receive mail notifications, make sure to install a mail server. By default, Debian is shipped with exim4 but this [has problems](https://gitlab.com/gitlab-org/gitlab-foss/issues/12754) while Ubuntu does not ship with one. The recommended mail server is postfix and you can install it with:
194

195 196 197
```sh
sudo apt-get install -y postfix
```
198 199

Then select 'Internet Site' and press enter to confirm the hostname.
200

201
## 2. Ruby
Valery Sizov's avatar
Valery Sizov committed
202

203 204
The Ruby interpreter is required to run GitLab.

205 206
**Note:** The current supported Ruby (MRI) version is 2.6.x. GitLab 12.2
  dropped support for Ruby 2.5.x.
dosire's avatar
dosire committed
207

208
The use of Ruby version managers such as [RVM], [rbenv](https://github.com/rbenv/rbenv) or [chruby] with GitLab
209 210 211
in production, frequently leads to hard to diagnose problems. For example,
GitLab Shell is called from OpenSSH, and having a version manager can prevent
pushing and pulling over SSH. Version managers are not supported and we strongly
Lin Jen-Shin's avatar
Lin Jen-Shin committed
212
advise everyone to follow the instructions below to use a system Ruby.
213 214 215

Linux distributions generally have older versions of Ruby available, so these
instructions are designed to install Ruby from the official source code.
216 217

Remove the old Ruby 1.8 if present:
218

219 220 221
```sh
sudo apt-get remove ruby1.8
```
222

223
Download Ruby and compile it:
224

225 226
```sh
mkdir /tmp/ruby && cd /tmp/ruby
Stan Hu's avatar
Stan Hu committed
227 228 229
curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.6/ruby-2.6.3.tar.gz
echo '2347ed6ca5490a104ebd5684d2b9b5eefa6cd33c  ruby-2.6.3.tar.gz' | shasum -c - && tar xzf ruby-2.6.3.tar.gz
cd ruby-2.6.3
230 231 232 233 234

./configure --disable-install-rdoc
make
sudo make install
```
Valery Sizov's avatar
Valery Sizov committed
235

236
Then install the Bundler gem (a version below 2.x):
237

238
```sh
239
sudo gem install bundler --no-document --version '< 2'
240
```
241

242 243
## 3. Go

244 245 246
Since GitLab 8.0, GitLab has several daemons written in Go. To install
GitLab we need a Go compiler. The instructions below assume you use 64-bit
Linux. You can find downloads for other platforms at the [Go download
247
page](https://golang.org/dl).
248

249 250 251 252
```sh
# Remove former Go installation folder
sudo rm -rf /usr/local/go

253 254 255
curl --remote-name --progress https://dl.google.com/go/go1.11.10.linux-amd64.tar.gz
echo 'aefaa228b68641e266d1f23f1d95dba33f17552ba132878b65bb798ffa37e6d0  go1.11.10.linux-amd64.tar.gz' | shasum -a256 -c - && \
  sudo tar -C /usr/local -xzf go1.11.10.linux-amd64.tar.gz
256
sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/
257
rm go1.11.10.linux-amd64.tar.gz
258
```
259

260 261
## 4. Node

262 263 264 265
Since GitLab 8.17, GitLab requires the use of Node to compile JavaScript
assets, and Yarn to manage JavaScript dependencies. The current minimum
requirements for these are:

Lukas Eipert's avatar
Lukas Eipert committed
266
- `node` >= v8.10.0. (We recommend node 12.x as it is faster)
267 268 269
- `yarn` >= v1.10.0.

In many distros,
270 271 272
the versions provided by the official package repositories are out of date, so
we'll need to install through the following commands:

273
```sh
Lukas Eipert's avatar
Lukas Eipert committed
274 275
# install node v12.x
curl --location https://deb.nodesource.com/setup_12.x | sudo bash -
276 277 278 279 280 281
sudo apt-get install -y nodejs

curl --silent --show-error https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update
sudo apt-get install yarn
282
```
283

Mike Greiling's avatar
Mike Greiling committed
284
Visit the official websites for [node](https://nodejs.org/en/download/package-manager/) and [yarn](https://yarnpkg.com/en/docs/install/) if you have any trouble with these steps.
285

286
## 5. System users
Riyad Preukschas's avatar
Riyad Preukschas committed
287

288
Create a `git` user for GitLab:
289

290 291 292
```sh
sudo adduser --disabled-login --gecos 'GitLab' git
```
Valery Sizov's avatar
Valery Sizov committed
293

294
## 6. Database
randx's avatar
randx committed
295

296
NOTE: **Note:**
297 298
Starting from GitLab 12.1, only PostgreSQL is supported. Because we need to make
use of extensions and concurrent index removal, you need at least PostgreSQL 9.2.
299

300 301
1. Install the database packages:

302 303 304
   ```sh
   sudo apt-get install -y postgresql postgresql-client libpq-dev postgresql-contrib
   ```
305 306 307

1. Create a database user for GitLab:

308 309 310
   ```sh
   sudo -u postgres psql -d template1 -c "CREATE USER git CREATEDB;"
   ```
311

312
1. Create the `pg_trgm` extension (required for GitLab 8.6+):
313

314 315 316
   ```sh
   sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;"
   ```
317

318
1. Create the GitLab production database and grant all privileges on database:
319

320 321 322
   ```sh
   sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;"
   ```
323

324 325
1. Try connecting to the new database with the new user:

326 327 328
   ```sh
   sudo -u git -H psql -d gitlabhq_production
   ```
329 330 331

1. Check if the `pg_trgm` extension is enabled:

332 333 334 335 336 337
   ```sh
   SELECT true AS enabled
   FROM pg_available_extensions
   WHERE name = 'pg_trgm'
   AND installed_version IS NOT NULL;
   ```
338

339
   If the extension is enabled this will produce the following output:
340

341 342 343 344 345 346
   ```
   enabled
   ---------
    t
   (1 row)
   ```
347 348

1. Quit the database session:
349

350 351 352
   ```sh
   gitlabhq_production> \q
   ```
randx's avatar
randx committed
353

354
## 7. Redis
355

356
GitLab requires at least Redis 2.8.
357

358
If you are using Debian 8 or Ubuntu 14.04 and up, you can simply install
359
Redis 2.8 with:
360 361

```sh
362 363
sudo apt-get install redis-server
```
364

365
Once done, you can configure Redis:
366

367
```sh
368 369
# Configure redis to use sockets
sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig
370

371
# Disable Redis listening on TCP by setting 'port' to 0
372
sudo sed 's/^port .*/port 0/' /etc/redis/redis.conf.orig | sudo tee /etc/redis/redis.conf
373

374 375
# Enable Redis socket for default Debian / Ubuntu path
echo 'unixsocket /var/run/redis/redis.sock' | sudo tee -a /etc/redis/redis.conf
376

377 378
# Grant permission to the socket to all members of the redis group
echo 'unixsocketperm 770' | sudo tee -a /etc/redis/redis.conf
379

380
# Create the directory which contains the socket
381 382 383
sudo mkdir -p /var/run/redis
sudo chown redis:redis /var/run/redis
sudo chmod 755 /var/run/redis
Hugo Osvaldo Barrera's avatar
Hugo Osvaldo Barrera committed
384

385 386 387 388
# Persist the directory which contains the socket, if applicable
if [ -d /etc/tmpfiles.d ]; then
  echo 'd  /var/run/redis  0755  redis  redis  10d  -' | sudo tee -a /etc/tmpfiles.d/redis.conf
fi
389

390
# Activate the changes to redis.conf
391
sudo service redis-server restart
392

393 394 395
# Add git to the redis group
sudo usermod -aG redis git
```
396

397
## 8. GitLab
Valery Sizov's avatar
Valery Sizov committed
398

399 400 401 402
```sh
# We'll install GitLab into home directory of the user "git"
cd /home/git
```
403

404
### Clone the Source
randx's avatar
randx committed
405

406 407
```sh
# Clone GitLab repository
408
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-foss.git -b X-Y-stable gitlab
409
```
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
410

411 412 413 414
Make sure to replace `X-Y-stable` with the stable branch that matches the
version you want to install. For example, if you want to install 11.8 you would
use the branch name `11-8-stable`.

415
CAUTION: **Caution:**
416
You can change `X-Y-stable` to `master` if you want the *bleeding edge* version, but never install `master` on a production server!
417

Ben Bodenmiller's avatar
Ben Bodenmiller committed
418
### Configure It
randx's avatar
randx committed
419

420 421 422
```sh
# Go to GitLab installation folder
cd /home/git/gitlab
423

424 425
# Copy the example GitLab config
sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml
Valery Sizov's avatar
Valery Sizov committed
426

427 428
# Update GitLab config file, follow the directions at top of file
sudo -u git -H editor config/gitlab.yml
429

430 431 432
# Copy the example secrets file
sudo -u git -H cp config/secrets.yml.example config/secrets.yml
sudo -u git -H chmod 0600 config/secrets.yml
433

434 435 436 437 438
# Make sure GitLab can write to the log/ and tmp/ directories
sudo chown -R git log/
sudo chown -R git tmp/
sudo chmod -R u+rwX,go-w log/
sudo chmod -R u+rwX tmp/
Riyad Preukschas's avatar
Riyad Preukschas committed
439

440 441 442
# Make sure GitLab can write to the tmp/pids/ and tmp/sockets/ directories
sudo chmod -R u+rwX tmp/pids/
sudo chmod -R u+rwX tmp/sockets/
443

444
# Create the public/uploads/ directory
445
sudo -u git -H mkdir -p public/uploads/
446

447 448 449
# Make sure only the GitLab user has access to the public/uploads/ directory
# now that files in public/uploads are served by gitlab-workhorse
sudo chmod 0700 public/uploads
450

451
# Change the permissions of the directory where CI job logs are stored
452
sudo chmod -R u+rwX builds/
453

454 455
# Change the permissions of the directory where CI artifacts are stored
sudo chmod -R u+rwX shared/artifacts/
456

457 458
# Change the permissions of the directory where GitLab Pages are stored
sudo chmod -R ug+rwX shared/pages/
Kamil Trzcinski's avatar
Kamil Trzcinski committed
459

460 461
# Copy the example Unicorn config
sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
462

463 464
# Find number of cores
nproc
465

466 467 468 469
# Enable cluster mode if you expect to have a high load instance
# Set the number of workers to at least the number of cores
# Ex. change amount of workers to 3 for 2GB RAM server
sudo -u git -H editor config/unicorn.rb
470

471 472
# Copy the example Rack attack config
sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb
473

474 475 476
# Configure Git global settings for git user
# 'autocrlf' is needed for the web editor
sudo -u git -H git config --global core.autocrlf input
477

478 479
# Disable 'git gc --auto' because GitLab already runs 'git gc' when needed
sudo -u git -H git config --global gc.auto 0
Jacob Vosmaer's avatar
Jacob Vosmaer committed
480

481 482
# Enable packfile bitmaps
sudo -u git -H git config --global repack.writeBitmaps true
483

484 485
# Enable push options
sudo -u git -H git config --global receive.advertisePushOptions true
486

487 488 489
# Enable fsyncObjectFiles to reduce risk of repository corruption if the server crashes
sudo -u git -H git config --global core.fsyncObjectFiles true

490 491
# Configure Redis connection settings
sudo -u git -H cp config/resque.yml.example config/resque.yml
492

493 494 495
# Change the Redis socket path if you are not using the default Debian / Ubuntu configuration
sudo -u git -H editor config/resque.yml
```
496

497
CAUTION: **Caution:**
Lukas Eipert's avatar
Lukas Eipert committed
498
Make sure to edit both `gitlab.yml` and `unicorn.rb` to match your setup.
499
If you want to use Puma web server, see [Using Puma](#using-puma) for the additional steps.
Riyad Preukschas's avatar
Riyad Preukschas committed
500

501 502
NOTE: **Note:**
If you want to use HTTPS, see [Using HTTPS](#using-https) for the additional steps.
503

Ben Bodenmiller's avatar
Ben Bodenmiller committed
504
### Configure GitLab DB Settings
505

506 507 508
```sh
sudo -u git cp config/database.yml.postgresql config/database.yml

509 510 511 512 513 514 515 516 517 518 519
# Remove host, username, and password lines from config/database.yml.
# Once modified, the `production` settings will be as follows:
#
#   production:
#     adapter: postgresql
#     encoding: unicode
#     database: gitlabhq_production
#     pool: 10
#
sudo -u git -H editor config/database.yml

520
# Remote PostgreSQL only:
521 522 523 524 525 526 527 528 529 530
# Update username/password in config/database.yml.
# You only need to adapt the production settings (first part).
# If you followed the database guide then please do as follows:
# Change 'secure password' with the value you have given to $password
# You can keep the double quotes around the password
sudo -u git -H editor config/database.yml

# Make config/database.yml readable to git only
sudo -u git -H chmod o-rwx config/database.yml
```
531

532
### Install Gems
533

534
NOTE: **Note:**
535
As of Bundler 1.5.2, you can invoke `bundle install -jN` (where `N` is the number of your processor cores) and enjoy parallel gems installation with measurable difference in completion time (~60% faster). Check the number of your cores with `nproc`. For more information, see this [post](https://thoughtbot.com/blog/parallel-gem-installing-using-bundler).
536 537 538 539 540

Make sure you have `bundle` (run `bundle -v`):

- `>= 1.5.2`, because some [issues](https://devcenter.heroku.com/changelog-items/411) were [fixed](https://github.com/bundler/bundler/pull/2817) in 1.5.2.
- `< 2.x`.
541

542 543 544
```sh
sudo -u git -H bundle install --deployment --without development test mysql aws kerberos
```
545

546 547
NOTE: **Note:**
If you want to use Kerberos for user authentication, omit `kerberos` in the `--without` option above.
548

Ben Bodenmiller's avatar
Ben Bodenmiller committed
549
### Install GitLab Shell
550

551
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
552

553 554 555
```sh
# Run the installation task for gitlab-shell (replace `REDIS_URL` if needed):
sudo -u git -H bundle exec rake gitlab:shell:install REDIS_URL=unix:/var/run/redis/redis.sock RAILS_ENV=production SKIP_STORAGE_VALIDATION=true
556

557 558 559 560
# By default, the gitlab-shell config is generated from your main GitLab config.
# You can review (and modify) the gitlab-shell config as follows:
sudo -u git -H editor /home/git/gitlab-shell/config.yml
```
561

562 563
NOTE: **Note:**
If you want to use HTTPS, see [Using HTTPS](#using-https) for the additional steps.
564

565
NOTE: **Note:**
566
Make sure your hostname can be resolved on the machine itself by either a proper DNS record or an additional line in `/etc/hosts` ("127.0.0.1  hostname"). This might be necessary, for example, if you set up GitLab behind a reverse proxy. If the hostname cannot be resolved, the final installation check will fail with `Check GitLab API access: FAILED. code: 401` and pushing commits will be rejected with `[remote rejected] master -> master (hook declined)`.
567

568 569
NOTE: **Note:**
GitLab Shell application startup time can be greatly reduced by disabling RubyGems. This can be done in several ways:
570

571 572 573
- Export `RUBYOPT=--disable-gems` environment variable for the processes.
- Compile Ruby with `configure --disable-rubygems` to disable RubyGems by default. Not recommended for system-wide Ruby.
- Omnibus GitLab [replaces the *shebang* line of the `gitlab-shell/bin/*` scripts](https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests/1707).
574

575
### Install GitLab Workhorse
576

577
GitLab-Workhorse uses [GNU Make](https://www.gnu.org/software/make/). The
578
following command-line will install GitLab-Workhorse in `/home/git/gitlab-workhorse`
579
which is the recommended location.
Jacob Vosmaer's avatar
Jacob Vosmaer committed
580

581 582 583
```sh
sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
```
584

Ville Skyttä's avatar
Ville Skyttä committed
585
You can specify a different Git repository by providing it as an extra parameter:
586

587 588 589
```sh
sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse,https://example.com/gitlab-workhorse.git]" RAILS_ENV=production
```
590

591
### Install GitLab-Elasticsearch-indexer
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609

GitLab-Elasticsearch-Indexer uses [GNU Make](https://www.gnu.org/software/make/). The
following command-line will install GitLab-Elasticsearch-Indexer in `/home/git/gitlab-elasticsearch-indexer`
which is the recommended location.

```sh
sudo -u git -H bundle exec rake "gitlab:indexer:install[/home/git/gitlab-elasticsearch-indexer]" RAILS_ENV=production
```

You can specify a different Git repository by providing it as an extra parameter:

```sh
sudo -u git -H bundle exec rake "gitlab:indexer:install[/home/git/gitlab-elasticsearch-indexer,https://example.com/gitlab-elasticsearch-indexer.git]" RAILS_ENV=production
```

The source code will first be fetched to the path specified by the first parameter. Then a binary will be built under its `bin` directory.
You will then need to update `gitlab.yml`'s `production -> elasticsearch -> indexer_path` setting to point to that binary.

610
### Install GitLab Pages
611

612
GitLab Pages uses [GNU Make](https://www.gnu.org/software/make/). This step is optional and only needed if you wish to host static sites from within GitLab. The following commands will install GitLab Pages in `/home/git/gitlab-pages`. For additional setup steps, consult the [administration guide](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/administration/pages/source.md) for your version of GitLab as the GitLab Pages daemon can be run several different ways.
613

614 615 616 617 618 619 620
```sh
cd /home/git
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
cd gitlab-pages
sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
sudo -u git -H make
```
621

622 623
### Install Gitaly

624 625
```sh
# Fetch Gitaly source with Git and compile with Go
626
cd /home/git/gitlab
627 628
sudo -u git -H bundle exec rake "gitlab:gitaly:install[/home/git/gitaly,/home/git/repositories]" RAILS_ENV=production
```
629 630 631

You can specify a different Git repository by providing it as an extra parameter:

632 633 634
```sh
sudo -u git -H bundle exec rake "gitlab:gitaly:install[/home/git/gitaly,/home/git/repositories,https://example.com/gitaly.git]" RAILS_ENV=production
```
635

636
Next, make sure that Gitaly is configured:
637

638 639 640 641
```sh
# Restrict Gitaly socket access
sudo chmod 0700 /home/git/gitlab/tmp/sockets/private
sudo chown git /home/git/gitlab/tmp/sockets/private
642

643 644 645 646
# If you are using non-default settings you need to update config.toml
cd /home/git/gitaly
sudo -u git -H editor config.toml
```
647 648

For more information about configuring Gitaly see
649
[the Gitaly documentation](../administration/gitaly/index.md).
650

651 652 653 654 655 656 657 658
### Start Gitaly

Gitaly must be running for the next section.

```sh
gitlab_path=/home/git/gitlab
gitaly_path=/home/git/gitaly

Kyohei Uemura's avatar
Kyohei Uemura committed
659 660
sudo -u git -H sh -c "$gitlab_path/bin/daemon_with_pidfile $gitlab_path/tmp/pids/gitaly.pid \
  $gitaly_path/gitaly $gitaly_path/config.toml >> $gitlab_path/log/gitaly.log 2>&1 &"
661 662
```

663
### Initialize Database and Activate Advanced Features
664

665
```sh
666
cd /home/git/gitlab
667 668
sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production
# Type 'yes' to create the database tables.
669

670 671
# or you can skip the question by adding force=yes
sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production force=yes
672

673 674
# When done you see 'Administrator account created:'
```
675

676
NOTE: **Note:**
677
You can set the Administrator/root password and e-mail by supplying them in environmental variables, `GITLAB_ROOT_PASSWORD` and `GITLAB_ROOT_EMAIL` respectively, as seen below. If you don't set the password (and it is set to the default one), wait to expose GitLab to the public internet until the installation is done and you've logged into the server the first time. During the first login, you'll be forced to change the default password. An Enterprise Edition license may also be installed at this time by supplying a full path in the `GITLAB_LICENSE_FILE` environment variable.
678

679
```sh
680
sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail GITLAB_LICENSE_FILE="/path/to/license"
681
```
682

683 684 685 686 687 688
### Secure secrets.yml

The `secrets.yml` file stores encryption keys for sessions and secure variables.
Backup `secrets.yml` someplace safe, but don't store it in the same place as your database backups.
Otherwise your secrets are exposed if one of your backups is compromised.

689
### Install Init Script
690

Ben Bodenmiller's avatar
Ben Bodenmiller committed
691
Download the init script (will be `/etc/init.d/gitlab`):
692

693 694 695
```sh
sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
```
696 697 698

And if you are installing with a non-default folder or user copy and edit the defaults file:

699 700 701
```sh
sudo cp lib/support/init.d/gitlab.default.example /etc/default/gitlab
```
702

703
If you installed GitLab in another directory or as a user other than the default, you should change these settings in `/etc/default/gitlab`. Do not edit `/etc/init.d/gitlab` as it will be changed on upgrade.
704 705 706

Make GitLab start on boot:

707 708 709
```sh
sudo update-rc.d gitlab defaults 21
```
710

711
### Set up Logrotate
712

713 714 715
```sh
sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab
```
716

717
### Check Application Status
718

719
Check if GitLab and its environment are configured correctly:
720

721 722 723
```sh
sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
```
724 725 726

### Compile GetText PO files

727 728 729
```sh
sudo -u git -H bundle exec rake gettext:compile RAILS_ENV=production
```
730

731
### Compile Assets
732

733 734 735 736
```sh
sudo -u git -H yarn install --production --pure-lockfile
sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production
```
737

738 739 740 741 742 743
If `rake` fails with `JavaScript heap out of memory` error, try to run it with `NODE_OPTIONS` set as follows.

```sh
sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production NODE_OPTIONS="--max_old_space_size=4096"
```

744
### Start Your GitLab Instance
745

746 747 748 749 750
```sh
sudo service gitlab start
# or
sudo /etc/init.d/gitlab restart
```
751

752
## 9. NGINX
Valery Sizov's avatar
Valery Sizov committed
753

754
NOTE: **Note:**
755
NGINX is the officially supported web server for GitLab. If you cannot or do not want to use NGINX as your web server, see [GitLab recipes](https://gitlab.com/gitlab-org/gitlab-recipes/).
756

757
### Installation
758

759 760 761
```sh
sudo apt-get install -y nginx
```
762

763
### Site Configuration
Riyad Preukschas's avatar
Riyad Preukschas committed
764

765
Copy the example site config:
Riyad Preukschas's avatar
Riyad Preukschas committed
766

767 768 769 770
```sh
sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
```
Valery Sizov's avatar
Valery Sizov committed
771

772
Make sure to edit the config file to match your setup. Also, ensure that you match your paths to GitLab, especially if installing for a user other than the `git` user:
Riyad Preukschas's avatar
Riyad Preukschas committed
773

774 775 776 777 778 779 780 781 782 783 784 785
```sh
# Change YOUR_SERVER_FQDN to the fully-qualified
# domain name of your host serving GitLab.
#
# Remember to match your paths to GitLab, especially
# if installing for a user other than 'git'.
#
# If using Ubuntu default nginx install:
# either remove the default_server from the listen line
# or else sudo rm -f /etc/nginx/sites-enabled/default
sudo editor /etc/nginx/sites-available/gitlab
```
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
786

787
If you intend to enable GitLab Pages, there is a separate NGINX config you need
788
to use. Read all about the needed configuration at the
789
[GitLab Pages administration guide](../administration/pages/index.md).
Kamil Trzcinski's avatar
Kamil Trzcinski committed
790

791
**Note:** If you want to use HTTPS, replace the `gitlab` NGINX config with `gitlab-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details.
Ben Bodenmiller's avatar
Ben Bodenmiller committed
792 793 794

### Test Configuration

795
Validate your `gitlab` or `gitlab-ssl` NGINX config file with the following command:
Ben Bodenmiller's avatar
Ben Bodenmiller committed
796

797 798 799
```sh
sudo nginx -t
```
800

801
You should receive `syntax is okay` and `test is successful` messages. If you receive errors check your `gitlab` or `gitlab-ssl` NGINX config file for typos, etc. as indicated in the error message given.
802

803 804 805 806 807
NOTE: **Note:**
Verify that the installed version is greater than 1.12.1 by running `nginx -v`. If it's lower, you may receive the error below:
`nginx: [emerg] unknown "start$temp=[filtered]$rest" variable
nginx: configuration file /etc/nginx/nginx.conf test failed`

808
### Restart
Riyad Preukschas's avatar
Riyad Preukschas committed
809

810 811 812
```sh
sudo service nginx restart
```
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
813

814
## Post-install
815

816
### Double-check Application Status
817 818 819

To make sure you didn't miss anything run a more thorough check with:

820 821 822
```sh
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
```
823

824
If all items are green, congratulations on successfully installing GitLab!
825

826 827
NOTE: Supply `SANITIZE=true` environment variable to `gitlab:check` to omit project names from the output of the check command.

828
### Initial Login
829

830
Visit YOUR_SERVER in your web browser for your first GitLab login.
Valery Sizov's avatar
Valery Sizov committed
831

832 833 834 835
If you didn't [provide a root password during setup](#initialize-database-and-activate-advanced-features),
you'll be redirected to a password reset screen to provide the password for the
initial administrator account. Enter your desired password and you'll be
redirected back to the login screen.
836

837 838
The default account's username is **root**. Provide the password you created
earlier and login. After login you can change the username if you wish.
Riyad Preukschas's avatar
Riyad Preukschas committed
839 840 841

**Enjoy!**

842 843
You can use `sudo service gitlab start` and `sudo service gitlab stop` to start and stop GitLab.

844
## Advanced Setup Tips
Valery Sizov's avatar
Valery Sizov committed
845

846 847 848
### Relative URL support

See the [Relative URL documentation](relative_url.md) for more information on
849
how to configure GitLab with a relative URL.
850

851 852
### Using HTTPS

853 854 855
To use GitLab with HTTPS:

1. In `gitlab.yml`:
856 857
   1. Set the `port` option in section 1 to `443`.
   1. Set the `https` option in section 1 to `true`.
858
1. In the `config.yml` of GitLab Shell:
859 860
   1. Set `gitlab_url` option to the HTTPS endpoint of GitLab (e.g. `https://git.example.com`).
   1. Set the certificates using either the `ca_file` or `ca_path` option.
861
1. Use the `gitlab-ssl` NGINX example config instead of the `gitlab` config.
862 863 864
   1. Update `YOUR_SERVER_FQDN`.
   1. Update `ssl_certificate` and `ssl_certificate_key`.
   1. Review the configuration file and consider applying other security and performance enhancing features.
865

866
Using a self-signed certificate is discouraged but if you must use it, follow the normal directions. Then:
867

Ben Bodenmiller's avatar
Ben Bodenmiller committed
868
1. Generate a self-signed SSL certificate:
869

870 871 872 873 874 875 876
   ```sh
   mkdir -p /etc/nginx/ssl/
   cd /etc/nginx/ssl/
   sudo openssl req -newkey rsa:2048 -x509 -nodes -days 3560 -out gitlab.crt -keyout gitlab.key
   sudo chmod o-r gitlab.key
   ```

877
1. In the `config.yml` of GitLab Shell set `self_signed_cert` to `true`.
878

879
### Enable Reply by email
Valery Sizov's avatar
Valery Sizov committed
880

881
See the ["Reply by email" documentation](../administration/reply_by_email.md) for more information on how to set this up.
882 883 884

### LDAP Authentication

885
You can configure LDAP authentication in `config/gitlab.yml`. Restart GitLab after editing this file.
886

887
### Using Custom OmniAuth Providers
888

889
See the [OmniAuth integration documentation](../integration/omniauth.md).
890 891 892

### Build your projects

893 894
GitLab can build your projects. To enable that feature, you need GitLab Runners to do that for you.
See the [GitLab Runner section](https://about.gitlab.com/product/continuous-integration/#gitlab-runner) to install it.
895

896 897
### Adding your Trusted Proxies

Ville Skyttä's avatar
Ville Skyttä committed
898
If you are using a reverse proxy on a separate machine, you may want to add the
899 900 901 902
proxy to the trusted proxies list. Otherwise users will appear signed in from the
proxy's IP address.

You can add trusted proxies in `config/gitlab.yml` by customizing the `trusted_proxies`
903 904
option in section 1. Save the file and [reconfigure GitLab](../administration/restart_gitlab.md)
for the changes to take effect.
905

906
### Custom Redis Connection
907

908
If you'd like to connect to a Redis server on a non-standard port or on a different host, you can configure its connection string via the `config/resque.yml` file.
909

910 911 912 913 914
```
# example
production:
  url: redis://redis.example.tld:6379
```
915

916
If you want to connect the Redis server via socket, use the "unix:" URL scheme and the path to the Redis socket file in the `config/resque.yml` file.
917

918 919 920 921 922
```
# example
production:
  url: unix:/path/to/redis/socket
```
923

924 925
Also you can use environment variables in the `config/resque.yml` file:

926 927 928 929 930
```
# example
production:
  url: <%= ENV.fetch('GITLAB_REDIS_URL') %>
```
931

932
### Custom SSH Connection
933

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

936 937 938 939 940 941 942
```
# Add to /home/git/.ssh/config
host localhost          # Give your setup a name (here: override localhost)
    user git            # Your remote git user
    port 2222           # Your port number
    hostname 127.0.0.1; # Your server name or IP
```
943

944
You also need to change the corresponding options (e.g. `ssh_user`, `ssh_host`, `admin_uri`) in the `config\gitlab.yml` file.
945

946
### Additional Markup Styles
947

948
Apart from the always supported Markdown style, there are other rich text files that GitLab can display. But you might have to install a dependency to do so. See the [`github-markup` gem README](https://github.com/gitlabhq/markup#markups) for more information.
949

950 951 952 953 954 955 956 957 958 959 960 961 962
### Using Puma

Puma is a multi-threaded HTTP 1.1 server for Ruby applications.

To use GitLab with Puma:

1. Finish GitLab setup so you have it up and running.
1. Copy the supplied example Puma config file into place:

   ```sh
   cd /home/git/gitlab

   # Copy config file for the web server
963
   sudo -u git -H cp config/puma.rb.example config/puma.rb
964 965 966 967 968
   ```

1. Edit the system `init.d` script to use `EXPERIMENTAL_PUMA=1` flag. If you have `/etc/default/gitlab`, then you should edit it instead.
1. Restart GitLab.

969 970 971 972 973
## Troubleshooting

### "You appear to have cloned an empty repository."

If you see this message when attempting to clone a repository hosted by GitLab,
974
this is likely due to an outdated NGINX or Apache configuration, or a missing or
975 976
misconfigured GitLab Workhorse instance. Double-check that you've
[installed Go](#3-go), [installed GitLab Workhorse](#install-gitlab-workhorse),
977
and correctly [configured NGINX](#site-configuration).
978

979
### `google-protobuf` "LoadError: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.14' not found"
980 981

This can happen on some platforms for some versions of the
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
`google-protobuf` gem. The workaround is to install a source-only
version of this gem.

First, you must find the exact version of `google-protobuf` that your
GitLab installation requires:

```sh
cd /home/git/gitlab

# Only one of the following two commands will print something. It
# will look like: * google-protobuf (3.2.0)
bundle list | grep google-protobuf
bundle check | grep google-protobuf
```

Below, `3.2.0` is used as an example. Replace it with the version number
you found above:

```sh
cd /home/git/gitlab
sudo -u git -H gem install google-protobuf --version 3.2.0 --platform ruby
```

Finally, you can test whether `google-protobuf` loads correctly. The
following should print 'OK'.

```sh
sudo -u git -H bundle exec ruby -rgoogle/protobuf -e 'puts :OK'
```

If the `gem install` command fails, you may need to install the developer
tools of your OS.

On Debian/Ubuntu:

```sh
sudo apt-get install build-essential libgmp-dev
```

On RedHat/CentOS:

```sh
sudo yum groupinstall 'Development Tools'
```
1026

1027 1028
[RVM]: https://rvm.io/ "RVM Homepage"
[chruby]: https://github.com/postmodern/chruby "chruby on GitHub"