installation.md 29.2 KB
Newer Older
1
# Installation from source
Marin Jankovski's avatar
Marin Jankovski committed
2

3 4
## Consider the Omnibus package installation

5
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/downloads/) (deb/rpm).
6

7 8
One reason the Omnibus package is more reliable is its use of Runit to restart any of the GitLab processes in case one crashes.
On heavily used GitLab instances the memory usage of the Sidekiq background worker will grow over time.
9
Omnibus packages solve this by [letting the Sidekiq terminate gracefully](http://docs.gitlab.com/ce/operations/sidekiq_memory_killer.html) if it uses too much memory.
10 11 12
After this termination Runit will detect Sidekiq is not running and will start it.
Since installations from source don't have Runit, Sidekiq can't be terminated and its memory usage will grow over time.

13 14
## Select Version to Install

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

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

20
## Important Notes
Valery Sizov's avatar
Valery Sizov committed
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).

24
This installation guide was created for and tested on **Debian/Ubuntu** operating systems. Please read [requirements.md](requirements.md) for hardware and operating system requirements. If you want to install on RHEL/CentOS we recommend using the [Omnibus packages](https://about.gitlab.com/downloads/).
25

26
This is the official installation guide to set up a production server. To set up a **development installation** or for many other installation options please see [the installation section of the readme](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/README.md#installation).
27

28
The following steps have been known to work. Please **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.
29

30 31 32
If you find a bug/error in this guide please **submit a merge request**
following the
[contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md).
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
33

34
## Overview
Valery Sizov's avatar
Valery Sizov committed
35

36
The GitLab installation consists of setting up the following components:
37

Riyad Preukschas's avatar
Riyad Preukschas committed
38
1. Packages / Dependencies
39
1. Ruby
40
1. Go
41
1. Node
42 43
1. System Users
1. Database
44
1. Redis
45 46
1. GitLab
1. Nginx
Valery Sizov's avatar
Valery Sizov committed
47

48
## 1. Packages / Dependencies
Valery Sizov's avatar
Valery Sizov committed
49

50 51
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
52

53 54 55 56 57 58
```sh
# run as root!
apt-get update -y
apt-get upgrade -y
apt-get install sudo -y
```
Valery Sizov's avatar
Valery Sizov committed
59

60
**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 please skip this and keep using the default editor.
61

62 63 64 65 66
```sh
# Install vim and set as default editor
sudo apt-get install -y vim
sudo update-alternatives --set editor /usr/bin/vim.basic
```
67

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

70 71 72 73 74
```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 \
  libxslt-dev libcurl4-openssl-dev libicu-dev logrotate rsync python-docutils pkg-config cmake
```
75

76 77 78
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).

79 80
If you want to use Kerberos for user authentication, then install libkrb5-dev:

81 82 83
```sh
sudo apt-get install libkrb5-dev
```
84

85
**Note:** If you don't know what Kerberos is, you can assume you don't need it.
86

87 88
Make sure you have the right version of Git installed

89 90 91
```sh
# Install Git
sudo apt-get install -y git-core
92

93 94 95
# Make sure Git is version 2.18.0 or higher
git --version
```
96

97
Is the system packaged Git too old? Remove it and compile from source.
98

99 100 101
```sh
# Remove packaged Git
sudo apt-get remove git-core
102

103 104
# Install dependencies
sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential
105

106 107 108 109 110 111 112
# Download and compile from source
cd /tmp
curl --remote-name --progress https://www.kernel.org/pub/software/scm/git/git-2.18.0.tar.gz
echo '94faf2c0b02a7920b0b46f4961d8e9cad08e81418614102898a55f980fa3e7e4  git-2.18.0.tar.gz' | shasum -a256 -c - && tar -xzf git-2.18.0.tar.gz
cd git-2.18.0/
./configure
make prefix=/usr/local all
113

114 115
# Install into /usr/local/bin
sudo make prefix=/usr/local install
116

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

120 121 122 123 124 125 126
For the [Custom Favicon](../customization/favicon.md) to work, graphicsmagick
needs to be installed.

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

127
**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-ce/issues/12754) while Ubuntu does not ship with one. The recommended mail server is postfix and you can install it with:
128

129 130 131
```sh
sudo apt-get install -y postfix
```
132 133

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

135
## 2. Ruby
Valery Sizov's avatar
Valery Sizov committed
136

137 138 139 140
The Ruby interpreter is required to run GitLab.

**Note:** The current supported Ruby (MRI) version is 2.3.x. GitLab 9.0 dropped
support for Ruby 2.1.x.
dosire's avatar
dosire committed
141

142 143 144 145
The use of Ruby version managers such as [RVM], [rbenv] or [chruby] with GitLab
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
146
advise everyone to follow the instructions below to use a system Ruby.
147 148 149

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

Remove the old Ruby 1.8 if present:
152

153 154 155
```sh
sudo apt-get remove ruby1.8
```
156

157
Download Ruby and compile it:
158

159 160 161 162 163 164 165 166 167 168
```sh
mkdir /tmp/ruby && cd /tmp/ruby
curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.5/ruby-2.5.3.tar.gz
echo 'f919a9fbcdb7abecd887157b49833663c5c15fda  ruby-2.5.3.tar.gz' | shasum -c - && tar xzf ruby-2.5.3.tar.gz
cd ruby-2.5.3

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

170
Then install the Bundler Gem:
171

172 173 174
```sh
sudo gem install bundler --no-document
```
175

176 177
## 3. Go

178 179 180
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
181
page](https://golang.org/dl).
182

183 184 185 186 187 188 189 190 191 192
```sh
# Remove former Go installation folder
sudo rm -rf /usr/local/go

curl --remote-name --progress https://dl.google.com/go/go1.10.3.linux-amd64.tar.gz
echo 'fa1b0e45d3b647c252f51f5e1204aba049cde4af177ef9f2181f43004f901035  go1.10.3.linux-amd64.tar.gz' | shasum -a256 -c - && \
  sudo tar -C /usr/local -xzf go1.10.3.linux-amd64.tar.gz
sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/
rm go1.10.3.linux-amd64.tar.gz
```
193

194 195
## 4. Node

196 197
Since GitLab 8.17, GitLab requires the use of Node to compile javascript
assets, and Yarn to manage javascript dependencies. The current minimum
198
requirements for these are node >= v8.10.0 and yarn >= v1.10.0. In many distros
199 200 201
the versions provided by the official package repositories are out of date, so
we'll need to install through the following commands:

202 203 204 205 206 207 208 209 210
```sh
# install node v8.x
curl --location https://deb.nodesource.com/setup_8.x | sudo bash -
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
211
```
212

Mike Greiling's avatar
Mike Greiling committed
213
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.
214 215

## 5. System Users
Riyad Preukschas's avatar
Riyad Preukschas committed
216

217
Create a `git` user for GitLab:
218

219 220 221
```sh
sudo adduser --disabled-login --gecos 'GitLab' git
```
Valery Sizov's avatar
Valery Sizov committed
222

223
## 6. Database
randx's avatar
randx committed
224

225 226
We recommend using a PostgreSQL database. For MySQL check the
[MySQL setup guide](database_mysql.md).
227

228 229
> **Note**: because we need to make use of extensions and concurrent index removal,
you need at least PostgreSQL 9.2.
230

231 232
1. Install the database packages:

233
    ```sh
234 235 236 237 238
    sudo apt-get install -y postgresql postgresql-client libpq-dev postgresql-contrib
    ```

1. Create a database user for GitLab:

239
    ```sh
240
    sudo -u postgres psql -d template1 -c "CREATE USER git CREATEDB;"
241
    ```
242

243
1. Create the `pg_trgm` extension (required for GitLab 8.6+):
244

245
    ```sh
246
    sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;"
247 248
    ```

249
1. Create the GitLab production database and grant all privileges on database:
250

251
    ```sh
252
    sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;"
253
    ```
254

255 256
1. Try connecting to the new database with the new user:

257
    ```sh
258
    sudo -u git -H psql -d gitlabhq_production
259 260 261 262
    ```

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

263
    ```sh
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
    SELECT true AS enabled
    FROM pg_available_extensions
    WHERE name = 'pg_trgm'
    AND installed_version IS NOT NULL;
    ```

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

    ```
    enabled
    ---------
     t
    (1 row)
    ```

1. Quit the database session:
280

281
    ```sh
282
    gitlabhq_production> \q
283
    ```
randx's avatar
randx committed
284

285
## 7. Redis
286

287
GitLab requires at least Redis 2.8.
288

289 290
If you are using Debian 8 or Ubuntu 14.04 and up, then you can simply install
Redis 2.8 with:
291 292

```sh
293 294
sudo apt-get install redis-server
```
295

296 297 298
If you are using Debian 7 or Ubuntu 12.04, follow the special documentation
on [an alternate Redis installation](redis.md). Once done, follow the rest of
the guide here.
299

300
```sh
301 302
# Configure redis to use sockets
sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig
303

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

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

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

313 314 315 316
# Create the directory which contains the socket
mkdir /var/run/redis
chown redis:redis /var/run/redis
chmod 755 /var/run/redis
Hugo Osvaldo Barrera's avatar
Hugo Osvaldo Barrera committed
317

318 319 320 321
# 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
322

323
# Activate the changes to redis.conf
324
sudo service redis-server restart
325

326 327 328
# Add git to the redis group
sudo usermod -aG redis git
```
329

330
## 8. GitLab
Valery Sizov's avatar
Valery Sizov committed
331

332 333 334 335
```sh
# We'll install GitLab into home directory of the user "git"
cd /home/git
```
336

337
### Clone the Source
randx's avatar
randx committed
338

339 340 341 342
```sh
# Clone GitLab repository
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 11-7-stable gitlab
```
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
343

344
**Note:** You can change `11-7-stable` to `master` if you want the *bleeding edge* version, but never install master on a production server!
345

Ben Bodenmiller's avatar
Ben Bodenmiller committed
346
### Configure It
randx's avatar
randx committed
347

348 349 350
```sh
# Go to GitLab installation folder
cd /home/git/gitlab
351

352 353
# Copy the example GitLab config
sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml
Valery Sizov's avatar
Valery Sizov committed
354

355 356
# Update GitLab config file, follow the directions at top of file
sudo -u git -H editor config/gitlab.yml
357

358 359 360
# 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
361

362 363 364 365 366
# 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
367

368 369 370
# 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/
371

372 373
# Create the public/uploads/ directory
sudo -u git -H mkdir public/uploads/
374

375 376 377
# 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
378

379 380
# Change the permissions of the directory where CI job traces are stored
sudo chmod -R u+rwX builds/
381

382 383
# Change the permissions of the directory where CI artifacts are stored
sudo chmod -R u+rwX shared/artifacts/
384

385 386
# 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
387

388 389
# Copy the example Unicorn config
sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
390

391 392
# Find number of cores
nproc
393

394 395 396 397
# 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
398

399 400
# Copy the example Rack attack config
sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb
401

402 403 404
# Configure Git global settings for git user
# 'autocrlf' is needed for the web editor
sudo -u git -H git config --global core.autocrlf input
405

406 407
# 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
408

409 410
# Enable packfile bitmaps
sudo -u git -H git config --global repack.writeBitmaps true
411

412 413
# Enable push options
sudo -u git -H git config --global receive.advertisePushOptions true
414

415 416
# Configure Redis connection settings
sudo -u git -H cp config/resque.yml.example config/resque.yml
417

418 419 420
# Change the Redis socket path if you are not using the default Debian / Ubuntu configuration
sudo -u git -H editor config/resque.yml
```
421

422
**Important Note:** Make sure to edit both `gitlab.yml` and `unicorn.rb` to match your setup.
Riyad Preukschas's avatar
Riyad Preukschas committed
423

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
426
### Configure GitLab DB Settings
427

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
```sh
# PostgreSQL only:
sudo -u git cp config/database.yml.postgresql config/database.yml

# MySQL only:
sudo -u git cp config/database.yml.mysql config/database.yml

# MySQL and remote PostgreSQL only:
# 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

# PostgreSQL and MySQL:
# Make config/database.yml readable to git only
sudo -u git -H chmod o-rwx config/database.yml
```
447

448
### Install Gems
449

450
**Note:** As of bundler 1.5.2, you can invoke `bundle install -jN` (where `N` the number of your processor cores) and enjoy the parallel gems installation with measurable difference in completion time (~60% faster). Check the number of your cores with `nproc`. For more information check this [post](https://robots.thoughtbot.com/parallel-gem-installing-using-bundler). First make sure you have bundler >= 1.5.2 (run `bundle -v`) as it addresses some [issues](https://devcenter.heroku.com/changelog-items/411) that were [fixed](https://github.com/bundler/bundler/pull/2817) in 1.5.2.
451

452 453 454
```sh
# For PostgreSQL (note, the option says "without ... mysql")
sudo -u git -H bundle install --deployment --without development test mysql aws kerberos
455

456 457 458
# Or if you use MySQL (note, the option says "without ... postgres")
sudo -u git -H bundle install --deployment --without development test postgres aws kerberos
```
459 460

**Note:** If you want to use Kerberos for user authentication, then omit `kerberos` in the `--without` option above.
461

Ben Bodenmiller's avatar
Ben Bodenmiller committed
462
### Install GitLab Shell
463

464
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
465

466 467 468
```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
469

470 471 472 473
# 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
```
474

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

477
**Note:** 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)".
478

479 480
**Note:** GitLab Shell application startup time can be greatly reduced by disabling RubyGems. This can be done in several manners:

481 482 483
- 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).
484

485
### Install gitlab-workhorse
486

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

491 492 493
```sh
sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
```
494

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

497 498 499
```sh
sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse,https://example.com/gitlab-workhorse.git]" RAILS_ENV=production
```
500

501 502 503 504
### Install gitlab-pages

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, please consult the [administration guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/administration/pages/source.md) for your version of GitLab as the GitLab Pages daemon can be ran several different ways.

505 506 507 508 509 510 511
```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
```
512

513 514
### Install Gitaly

515 516 517 518
```sh
# Fetch Gitaly source with Git and compile with Go
sudo -u git -H bundle exec rake "gitlab:gitaly:install[/home/git/gitaly,/home/git/repositories]" RAILS_ENV=production
```
519 520 521

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

522 523 524
```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
```
525 526 527

Next, make sure gitaly configured:

528 529 530 531
```sh
# Restrict Gitaly socket access
sudo chmod 0700 /home/git/gitlab/tmp/sockets/private
sudo chown git /home/git/gitlab/tmp/sockets/private
532

533 534 535 536
# If you are using non-default settings you need to update config.toml
cd /home/git/gitaly
sudo -u git -H editor config.toml
```
537 538 539 540

For more information about configuring Gitaly see
[doc/administration/gitaly](../administration/gitaly).

541
### Initialize Database and Activate Advanced Features
542

543 544 545
```sh
sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production
# Type 'yes' to create the database tables.
546

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

550 551
# When done you see 'Administrator account created:'
```
552

553
**Note:** 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) please wait with exposing 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.
554

555 556 557
```sh
sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail
```
558

559 560 561 562 563 564
### 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.

565
### Install Init Script
566

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

569 570 571
```sh
sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
```
572 573 574

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

575 576 577
```sh
sudo cp lib/support/init.d/gitlab.default.example /etc/default/gitlab
```
578

Ben Bodenmiller's avatar
Ben Bodenmiller committed
579
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.
580 581 582

Make GitLab start on boot:

583 584 585
```sh
sudo update-rc.d gitlab defaults 21
```
586

587
### Set up Logrotate
588

589 590 591
```sh
sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab
```
592

593
### Check Application Status
594

595
Check if GitLab and its environment are configured correctly:
596

597 598 599
```sh
sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
```
600 601 602

### Compile GetText PO files

603 604 605
```sh
sudo -u git -H bundle exec rake gettext:compile RAILS_ENV=production
```
606

607
### Compile Assets
608

609 610 611 612
```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
```
613

614
### Start Your GitLab Instance
615

616 617 618 619 620
```sh
sudo service gitlab start
# or
sudo /etc/init.d/gitlab restart
```
621

622
## 9. Nginx
Valery Sizov's avatar
Valery Sizov committed
623

624
**Note:** Nginx is the officially supported web server for GitLab. If you cannot or do not want to use Nginx as your web server, have a look at the [GitLab recipes](https://gitlab.com/gitlab-org/gitlab-recipes/).
625

626
### Installation
627

628 629 630
```sh
sudo apt-get install -y nginx
```
631

632
### Site Configuration
Riyad Preukschas's avatar
Riyad Preukschas committed
633

634
Copy the example site config:
Riyad Preukschas's avatar
Riyad Preukschas committed
635

636 637 638 639
```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
640

641
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
642

643 644 645 646 647 648 649 650 651 652 653 654
```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
655

656 657
If you intend to enable GitLab pages, there is a separate Nginx config you need
to use. Read all about the needed configuration at the
658
[GitLab Pages administration guide](../administration/pages/index.md).
Kamil Trzcinski's avatar
Kamil Trzcinski committed
659

660
**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
661 662 663 664 665

### Test Configuration

Validate your `gitlab` or `gitlab-ssl` Nginx config file with the following command:

666 667 668
```sh
sudo nginx -t
```
669

670
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.
671

672
### Restart
Riyad Preukschas's avatar
Riyad Preukschas committed
673

674 675 676
```sh
sudo service nginx restart
```
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
677

678
## Done!
679

680
### Double-check Application Status
681 682 683

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

684 685 686
```sh
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
```
687 688 689

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

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

692
### Initial Login
693

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

696 697 698 699
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.
700

701 702
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
703 704 705

**Enjoy!**

706 707
You can use `sudo service gitlab start` and `sudo service gitlab stop` to start and stop GitLab.

708
## Advanced Setup Tips
Valery Sizov's avatar
Valery Sizov committed
709

710 711 712
### Relative URL support

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

715 716
### Using HTTPS

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
To use GitLab with HTTPS:

1. In `gitlab.yml`:
    1. Set the `port` option in section 1 to `443`.
    1. Set the `https` option in section 1 to `true`.
1. In the `config.yml` of gitlab-shell:
    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.
1. Use the `gitlab-ssl` Nginx example config instead of the `gitlab` config.
    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.

Using a self-signed certificate is discouraged but if you must use it follow the normal directions then:

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
734 735 736 737 738 739 740
    ```
    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
    ```
1. In the `config.yml` of gitlab-shell set `self_signed_cert` to `true`.
741

742
### Enable Reply by email
Valery Sizov's avatar
Valery Sizov committed
743

744
See the ["Reply by email" documentation](../administration/reply_by_email.md) for more information on how to set this up.
745 746 747 748 749 750 751 752 753 754 755 756

### LDAP Authentication

You can configure LDAP authentication in `config/gitlab.yml`. Please restart GitLab after editing this file.

### Using Custom Omniauth Providers

See the [omniauth integration document](../integration/omniauth.md)

### Build your projects

GitLab can build your projects. To enable that feature you need GitLab Runners to do that for you.
Robert Schilling's avatar
Robert Schilling committed
757
Checkout the [GitLab Runner section](https://about.gitlab.com/gitlab-ci/#gitlab-runner) to install it
758

759 760
### Adding your Trusted Proxies

Ville Skyttä's avatar
Ville Skyttä committed
761
If you are using a reverse proxy on a separate machine, you may want to add the
762 763 764 765
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`
766 767
option in section 1. Save the file and [reconfigure GitLab](../administration/restart_gitlab.md)
for the changes to take effect.
768

769
### Custom Redis Connection
770

771
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.
772

773 774 775 776 777
```
# example
production:
  url: redis://redis.example.tld:6379
```
778

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

781 782 783 784 785
```
# example
production:
  url: unix:/path/to/redis/socket
```
786

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

789 790 791 792 793
```
# example
production:
  url: <%= ENV.fetch('GITLAB_REDIS_URL') %>
```
794

795
### Custom SSH Connection
796

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

799 800 801 802 803 804 805
```
# 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
```
806

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

809
### Additional Markup Styles
810

811
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. Please see the [github-markup gem readme](https://github.com/gitlabhq/markup#markups) for more information.
812 813 814 815 816 817

## Troubleshooting

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

If you see this message when attempting to clone a repository hosted by GitLab,
818
this is likely due to an outdated Nginx or Apache configuration, or a missing or
819 820
misconfigured gitlab-workhorse instance. Double-check that you've
[installed Go](#3-go), [installed gitlab-workhorse](#install-gitlab-workhorse),
821
and correctly [configured Nginx](#site-configuration).
822

823 824 825 826 827 828
### google-protobuf "LoadError: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.14' not found"

This can happen on some platforms for some versions of the
google-protobuf gem. The workaround is to [install a source-only
version of this gem](google-protobuf.md).

829 830 831
[RVM]: https://rvm.io/ "RVM Homepage"
[rbenv]: https://github.com/sstephenson/rbenv "rbenv on GitHub"
[chruby]: https://github.com/postmodern/chruby "chruby on GitHub"