BigW Consortium Gitlab

installation.md 28.1 KB
Newer Older
1
# Installation from source
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 tag (version) of GitLab you would like to install.
16 17
In most cases this should be the highest numbered production tag (without rc in it).
You can select the tag in the version dropdown in the top left corner of GitLab (below the menu bar).
18

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

21
## Important Notes
Valery Sizov committed
22

23 24
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).

25
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/).
26

27
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).
28

29
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.
30

31 32 33
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).
34

35
## Overview
Valery Sizov committed
36

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

39
1. Packages / Dependencies
40
1. Ruby
41
1. Go
42
1. Node
43 44
1. System Users
1. Database
45
1. Redis
46 47
1. GitLab
1. Nginx
Valery Sizov committed
48

49
## 1. Packages / Dependencies
Valery Sizov committed
50

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

54 55 56 57
    # run as root!
    apt-get update -y
    apt-get upgrade -y
    apt-get install sudo -y
Valery Sizov committed
58

59
**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.
60

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

dosire committed
65
Install the required packages (needed to compile Ruby and native extensions to Ruby gems):
66

67
    sudo apt-get install -y build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libreadline-dev libncurses5-dev libffi-dev curl openssh-server checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libicu-dev logrotate python-docutils pkg-config cmake
68 69 70 71 72

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

    sudo apt-get install libkrb5-dev

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

75 76 77 78 79
Make sure you have the right version of Git installed

    # Install Git
    sudo apt-get install -y git-core

80
    # Make sure Git is version 2.8.4 or higher
81 82
    git --version

83
Is the system packaged Git too old? Remove it and compile from source.
84 85 86 87 88

    # Remove packaged Git
    sudo apt-get remove git-core

    # Install dependencies
89
    sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential
90 91 92

    # Download and compile from source
    cd /tmp
93 94 95
    curl --remote-name --progress https://www.kernel.org/pub/software/scm/git/git-2.8.4.tar.gz
    echo '626e319f8a24fc0866167ea5f6bf3e2f38f69d6cb2e59e150f13709ca3ebf301  git-2.8.4.tar.gz' | shasum -a256 -c - && tar -xzf git-2.8.4.tar.gz
    cd git-2.8.4/
Ben Bodenmiller committed
96
    ./configure
97 98 99 100 101
    make prefix=/usr/local all

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

102
    # When editing config/gitlab.yml (Step 5), change the git -> bin_path to /usr/local/bin/git
103

Sytse Sijbrandij committed
104
**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://github.com/gitlabhq/gitlabhq/issues/4866#issuecomment-32726573) while Ubuntu does not ship with one. The recommended mail server is postfix and you can install it with:
105

106
    sudo apt-get install -y postfix
107 108

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

110
## 2. Ruby
Valery Sizov committed
111

112 113 114 115
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 committed
116

117 118 119 120
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
121 122 123 124
advise everyone to follow the instructions below to use a system Ruby.  

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

Remove the old Ruby 1.8 if present:
127

128
    sudo apt-get remove ruby1.8
129

130
Download Ruby and compile it:
131

132
    mkdir /tmp/ruby && cd /tmp/ruby
Z.J. van de Weg committed
133
    curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.3/ruby-2.3.3.tar.gz
134
    echo '1014ee699071aa2ddd501907d18cbe15399c997d  ruby-2.3.3.tar.gz' | shasum -c - && tar xzf ruby-2.3.3.tar.gz
Z.J. van de Weg committed
135
    cd ruby-2.3.3
136
    ./configure --disable-install-rdoc
Valery Sizov committed
137 138 139
    make
    sudo make install

140
Then install the Bundler Gem:
141

142
    sudo gem install bundler --no-ri --no-rdoc
143

144 145
## 3. Go

146 147 148 149
Since GitLab 8.0, Git HTTP requests are handled by gitlab-workhorse (formerly
gitlab-git-http-server). This is a small daemon written in Go. To install
gitlab-workhorse 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
150
page](https://golang.org/dl).
151

152 153 154
    # Remove former Go installation folder
    sudo rm -rf /usr/local/go

155
    curl --remote-name --progress https://storage.googleapis.com/golang/go1.5.3.linux-amd64.tar.gz
156
    echo '43afe0c5017e502630b1aea4d44b8a7f059bf60d7f29dfd58db454d4e4e0ae53  go1.5.3.linux-amd64.tar.gz' | shasum -a256 -c - && \
Stan Hu committed
157
      sudo tar -C /usr/local -xzf go1.5.3.linux-amd64.tar.gz
158
    sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/
Stan Hu committed
159
    rm go1.5.3.linux-amd64.tar.gz
160

161 162 163
## 4. Node

Since GitLab 8.17, GitLab requires the use of node >= v4.3.0 to compile
164 165 166
javascript assets, and yarn >= v0.17.0 to manage javascript dependencies.
In many distros the versions provided by the official package  repositories
are out of date, so we'll need to install through the following commands:
167 168 169 170 171 172 173 174

    # install node v7.x
    curl --location https://deb.nodesource.com/setup_7.x | bash -
    sudo apt-get install -y nodejs

    # install yarn
    curl --location https://yarnpkg.com/install.sh | bash -

Mike Greiling committed
175
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.
176 177

## 5. System Users
178

179
Create a `git` user for GitLab:
180

181
    sudo adduser --disabled-login --gecos 'GitLab' git
Valery Sizov committed
182

183
## 6. Database
randx committed
184

185 186
We recommend using a PostgreSQL database. For MySQL check the
[MySQL setup guide](database_mysql.md).
187

188
> **Note**: because we need to make use of extensions you need at least pgsql 9.1.
189

190 191 192 193 194 195 196 197 198
1. Install the database packages:

    ```bash
    sudo apt-get install -y postgresql postgresql-client libpq-dev postgresql-contrib
    ```

1. Create a database user for GitLab:

    ```bash
199
    sudo -u postgres psql -d template1 -c "CREATE USER git CREATEDB;"
200
    ```
201

202
1. Create the `pg_trgm` extension (required for GitLab 8.6+):
203 204

    ```bash
205
    sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;"
206 207
    ```

208
1. Create the GitLab production database and grant all privileges on database:
209 210

    ```bash
211
    sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;"
212
    ```
213

214 215 216
1. Try connecting to the new database with the new user:

    ```bash
217
    sudo -u git -H psql -d gitlabhq_production
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    ```

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

    ```bash
    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:
239

240
    ```bash
241
    gitlabhq_production> \q
242
    ```
randx committed
243

244
## 7. Redis
245

246
GitLab requires at least Redis 2.8.
247

248 249
If you are using Debian 8 or Ubuntu 14.04 and up, then you can simply install
Redis 2.8 with:
250 251

```sh
252 253
sudo apt-get install redis-server
```
254

255 256 257
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.
258

259
```
260 261
# Configure redis to use sockets
sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig
262

263 264
# 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
265

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

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

272 273 274 275
# 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 committed
276

277 278 279 280
# 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
281

282
# Activate the changes to redis.conf
283
sudo service redis-server restart
284

285 286 287
# Add git to the redis group
sudo usermod -aG redis git
```
288

289
## 8. GitLab
Valery Sizov committed
290

291 292
    # We'll install GitLab into home directory of the user "git"
    cd /home/git
293

294
### Clone the Source
randx committed
295

296
    # Clone GitLab repository
297
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 9-2-stable gitlab
Dmitriy Zaporozhets committed
298

299
**Note:** You can change `9-2-stable` to `master` if you want the *bleeding edge* version, but never install master on a production server!
300

Ben Bodenmiller committed
301
### Configure It
randx committed
302

303
    # Go to GitLab installation folder
304
    cd /home/git/gitlab
305

306
    # Copy the example GitLab config
307
    sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml
Valery Sizov committed
308

309
    # Update GitLab config file, follow the directions at top of file
310
    sudo -u git -H editor config/gitlab.yml
311

312 313 314
    # 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
315

316
    # Make sure GitLab can write to the log/ and tmp/ directories
317 318
    sudo chown -R git log/
    sudo chown -R git tmp/
319
    sudo chmod -R u+rwX,go-w log/
320
    sudo chmod -R u+rwX tmp/
321

322 323 324
    # 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/
325

326 327 328
    # Create the public/uploads/ directory
    sudo -u git -H mkdir public/uploads/

329 330
    # Make sure only the GitLab user has access to the public/uploads/ directory
    # now that files in public/uploads are served by gitlab-workhorse
331
    sudo chmod 0700 public/uploads
332

333
    # Change the permissions of the directory where CI job traces are stored
334
    sudo chmod -R u+rwX builds/
335

336 337 338
    # Change the permissions of the directory where CI artifacts are stored
    sudo chmod -R u+rwX shared/artifacts/

339
    # Change the permissions of the directory where GitLab Pages are stored
Kamil Trzcinski committed
340 341
    sudo chmod -R ug+rwX shared/pages/

342
    # Copy the example Unicorn config
343
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
Andrey Kumanyaev committed
344

345 346
    # Find number of cores
    nproc
347

348
    # Enable cluster mode if you expect to have a high load instance
349
    # Set the number of workers to at least the number of cores
350
    # Ex. change amount of workers to 3 for 2GB RAM server
Lukas Elmer committed
351
    sudo -u git -H editor config/unicorn.rb
352

353 354 355
    # Copy the example Rack attack config
    sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb

Jacob Vosmaer committed
356 357
    # Configure Git global settings for git user
    # 'autocrlf' is needed for the web editor
358 359
    sudo -u git -H git config --global core.autocrlf input

Jacob Vosmaer committed
360 361 362
    # Disable 'git gc --auto' because GitLab already runs 'git gc' when needed
    sudo -u git -H git config --global gc.auto 0

363 364 365
    # Enable packfile bitmaps
    sudo -u git -H git config --global repack.writeBitmaps true

366 367 368
    # Configure Redis connection settings
    sudo -u git -H cp config/resque.yml.example config/resque.yml

369
    # Change the Redis socket path if you are not using the default Debian / Ubuntu configuration
370 371
    sudo -u git -H editor config/resque.yml

372
**Important Note:** Make sure to edit both `gitlab.yml` and `unicorn.rb` to match your setup.
373

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

Ben Bodenmiller committed
376
### Configure GitLab DB Settings
377

378
    # PostgreSQL only:
379
    sudo -u git cp config/database.yml.postgresql config/database.yml
380

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

384
    # MySQL and remote PostgreSQL only:
385
    # Update username/password in config/database.yml.
386
    # You only need to adapt the production settings (first part).
387
    # If you followed the database guide then please do as follows:
388 389
    # Change 'secure password' with the value you have given to $password
    # You can keep the double quotes around the password
390
    sudo -u git -H editor config/database.yml
391

392
    # PostgreSQL and MySQL:
393 394
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml
395

396
### Install Gems
397

398
**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.
399

400
    # For PostgreSQL (note, the option says "without ... mysql")
401
    sudo -u git -H bundle install --deployment --without development test mysql aws kerberos
402

403
    # Or if you use MySQL (note, the option says "without ... postgres")
404 405 406
    sudo -u git -H bundle install --deployment --without development test postgres aws kerberos

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

Ben Bodenmiller committed
408
### Install GitLab Shell
409

410
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
411 412

    # Run the installation task for gitlab-shell (replace `REDIS_URL` if needed):
413
    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
414

415
    # By default, the gitlab-shell config is generated from your main GitLab config.
416
    # You can review (and modify) the gitlab-shell config as follows:
417
    sudo -u git -H editor /home/git/gitlab-shell/config.yml
418

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

421
**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)".
422

423
### Install gitlab-workhorse
424

425
GitLab-Workhorse uses [GNU Make](https://www.gnu.org/software/make/). The
426
following command-line will install GitLab-Workhorse in `/home/git/gitlab-workhorse`
427
which is the recommended location.
Jacob Vosmaer committed
428

429
    sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
430

431 432 433 434 435
You can specify a different Git repository by providing it as an extra paramter:

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


436
### Initialize Database and Activate Advanced Features
437

438 439 440 441 442 443
    sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production

    # Type 'yes' to create the database tables.

    # When done you see 'Administrator account created:'

444
**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.
445

446
    sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail
447

448 449 450 451 452 453
### 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.

454
### Install Init Script
455

Ben Bodenmiller committed
456
Download the init script (will be `/etc/init.d/gitlab`):
457

458
    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
459 460 461 462

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

    sudo cp lib/support/init.d/gitlab.default.example /etc/default/gitlab
463

Ben Bodenmiller committed
464
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.
465 466 467 468 469

Make GitLab start on boot:

    sudo update-rc.d gitlab defaults 21

470 471
### Install Gitaly

472 473 474
As of GitLab 9.1 Gitaly is an **optional** component. Its
configuration is still changing regularly. It is OK to wait
with setting up Gitaly until you upgrade to GitLab 9.2 or later.
475 476 477 478

    # Fetch Gitaly source with Git and compile with Go
    sudo -u git -H bundle exec rake "gitlab:gitaly:install[/home/git/gitaly]" RAILS_ENV=production

479 480 481 482 483 484
You can specify a different Git repository by providing it as an extra paramter:

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

Next, make sure gitaly configured:

485 486 487 488
    # Restrict Gitaly socket access
    sudo chmod 0700 /home/git/gitlab/tmp/sockets/private
    sudo chown git /home/git/gitlab/tmp/sockets/private

489
    # If you are using non-default settings you need to update config.toml
490
    cd /home/git/gitaly
491
    sudo -u git -H editor config.toml
492

493 494 495
    # Enable Gitaly in the init script
    echo 'gitaly_enabled=true' | sudo tee -a /etc/default/gitlab

496
Next, edit `/home/git/gitlab/config/gitlab.yml` and make sure `enabled: true` in
497 498 499 500
the `gitaly:` section is uncommented.

    # <- gitlab.yml indentation starts here
      gitaly:
501
        enabled: true
502

Jacob Vosmaer committed
503 504 505
For more information about configuring Gitaly see
[doc/administration/gitaly](../administration/gitaly).

506
### Setup Logrotate
507 508

    sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab
509

510
### Check Application Status
511

512
Check if GitLab and its environment are configured correctly:
513

514
    sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
515

516
### Compile Assets
517

518
    sudo -u git -H yarn install --production --pure-lockfile
519
    sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production
520

521
### Start Your GitLab Instance
522 523 524 525 526

    sudo service gitlab start
    # or
    sudo /etc/init.d/gitlab restart

527
## 9. Nginx
Valery Sizov committed
528

529
**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/).
530

531
### Installation
532

533
    sudo apt-get install -y nginx
534

535
### Site Configuration
536

537
Copy the example site config:
538

539
    sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
540
    sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
Valery Sizov committed
541

542
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:
543

544 545
    # Change YOUR_SERVER_FQDN to the fully-qualified
    # domain name of your host serving GitLab.
546 547 548 549
    #
    # Remember to match your paths to GitLab, especially
    # if installing for a user other than 'git'.
    #
550 551
    # If using Ubuntu default nginx install:
    # either remove the default_server from the listen line
552
    # or else sudo rm -f /etc/nginx/sites-enabled/default
553
    sudo editor /etc/nginx/sites-available/gitlab
Dmitriy Zaporozhets committed
554

555 556
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
557
[GitLab Pages administration guide](../administration/pages/index.md).
Kamil Trzcinski committed
558

559
**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 committed
560 561 562 563 564 565

### Test Configuration

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

    sudo nginx -t
566

567
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.
568

569
### Restart
570

571
    sudo service nginx restart
Dmitriy Zaporozhets committed
572

573
## Done!
574

575
### Double-check Application Status
576 577 578 579 580 581 582

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

    sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production

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

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

585
### Initial Login
586

587
Visit YOUR_SERVER in your web browser for your first GitLab login.
Valery Sizov committed
588

589 590 591 592
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.
593

594 595
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.
596 597 598

**Enjoy!**

599 600
You can use `sudo service gitlab start` and `sudo service gitlab stop` to start and stop GitLab.

601
## Advanced Setup Tips
Valery Sizov committed
602

603 604 605
### Relative URL support

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

608 609
### Using HTTPS

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
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 committed
625
1. Generate a self-signed SSL certificate:
626

Ben Bodenmiller committed
627 628 629 630 631 632 633
    ```
    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`.
634

635
### Enable Reply by email
Valery Sizov committed
636

637
See the ["Reply by email" documentation](../administration/reply_by_email.md) for more information on how to set this up.
638 639 640 641 642 643 644 645 646 647 648 649

### 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 committed
650
Checkout the [GitLab Runner section](https://about.gitlab.com/gitlab-ci/#gitlab-runner) to install it
651

652 653 654 655 656 657 658
### Adding your Trusted Proxies

If you are using a reverse proxy on an separate machine, you may want to add the
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`
659 660
option in section 1. Save the file and [reconfigure GitLab](../administration/restart_gitlab.md)
for the changes to take effect.
661

662
### Custom Redis Connection
663

664
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.
665

666
    # example
667
    production:
668
      url: redis://redis.example.tld:6379
669

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

    # example
673
    production:
674
      url: unix:/path/to/redis/socket
675

676 677 678 679 680 681
Also you can use environment variables in the `config/resque.yml` file:

    # example
    production:
      url: <%= ENV.fetch('GITLAB_REDIS_URL') %>

682
### Custom SSH Connection
683

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

686
    # Add to /home/git/.ssh/config
687 688 689 690
    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
691

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

694
### Additional Markup Styles
695

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

## Troubleshooting

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

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

708 709 710 711 712 713
### 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).

714 715 716
[RVM]: https://rvm.io/ "RVM Homepage"
[rbenv]: https://github.com/sstephenson/rbenv "rbenv on GitHub"
[chruby]: https://github.com/postmodern/chruby "chruby on GitHub"