installation.md 25.5 KB
Newer Older
1
# Installation from source
M
Marin Jankovski 已提交
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

S
Sytse Sijbrandij 已提交
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
V
Valery Sizov 已提交
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.
S
Sytse Sijbrandij 已提交
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).
D
Dmitriy Zaporozhets 已提交
34

35
## Overview
V
Valery Sizov 已提交
36

P
PaulWagener 已提交
37
The GitLab installation consists of setting up the following components:
38

R
Riyad Preukschas 已提交
39
1. Packages / Dependencies
40
1. Ruby
41
1. Go
42 43
1. System Users
1. Database
44
1. Redis
45 46
1. GitLab
1. Nginx
V
Valery Sizov 已提交
47

48
## 1. Packages / Dependencies
V
Valery Sizov 已提交
49

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

53 54 55 56
    # run as root!
    apt-get update -y
    apt-get upgrade -y
    apt-get install sudo -y
V
Valery Sizov 已提交
57

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

S
Sytse Sijbrandij 已提交
60
    # Install vim and set as default editor
61
    sudo apt-get install -y vim
S
Sytse Sijbrandij 已提交
62
    sudo update-alternatives --set editor /usr/bin/vim.basic
63

D
dosire 已提交
64
Install the required packages (needed to compile Ruby and native extensions to Ruby gems):
65

66
    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 nodejs
67 68 69 70 71

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

    sudo apt-get install libkrb5-dev

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

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

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

79
    # Make sure Git is version 2.7.4 or higher
80 81
    git --version

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

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

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

    # Download and compile from source
    cd /tmp
92
    curl --remote-name --progress https://www.kernel.org/pub/software/scm/git/git-2.7.4.tar.gz
93 94
    echo '7104c4f5d948a75b499a954524cb281fe30c6649d8abe20982936f75ec1f275b  git-2.7.4.tar.gz' | shasum -a256 -c - && tar -xzf git-2.7.4.tar.gz
    cd git-2.7.4/
B
Ben Bodenmiller 已提交
95
    ./configure
96 97 98 99 100
    make prefix=/usr/local all

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

B
Ben Bodenmiller 已提交
101
    # When editing config/gitlab.yml (Step 5), change the git -> bin_path to /usr/local/bin/git
102

S
Sytse Sijbrandij 已提交
103
**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:
104

105
    sudo apt-get install -y postfix
106 107

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

109
## 2. Ruby
V
Valery Sizov 已提交
110

111
**Note:** The current supported Ruby versions are 2.1.x and 2.3.x. 2.3.x is preferred, and support for 2.1.x will be dropped in the future.
D
dosire 已提交
112

113 114 115 116 117 118 119
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
advise everyone to follow the instructions below to use a system Ruby.

Remove the old Ruby 1.8 if present:
120

121
    sudo apt-get remove ruby1.8
122

123
Download Ruby and compile it:
124

125
    mkdir /tmp/ruby && cd /tmp/ruby
126 127 128
    curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.3/ruby-2.3.1.tar.gz
    echo 'c39b4001f7acb4e334cb60a0f4df72d434bef711  ruby-2.3.1.tar.gz' | shasum -c - && tar xzf ruby-2.3.1.tar.gz
    cd ruby-2.3.1
129
    ./configure --disable-install-rdoc
V
Valery Sizov 已提交
130 131 132
    make
    sudo make install

133 134
Install the Bundler Gem:

135
    sudo gem install bundler --no-ri --no-rdoc
136

137 138
## 3. Go

139 140 141 142
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
143
page](https://golang.org/dl).
144

145 146 147
    # Remove former Go installation folder
    sudo rm -rf /usr/local/go

148
    curl --remote-name --progress https://storage.googleapis.com/golang/go1.5.3.linux-amd64.tar.gz
J
Jacob Vosmaer 已提交
149
    echo '43afe0c5017e502630b1aea4d44b8a7f059bf60d7f29dfd58db454d4e4e0ae53  go1.5.3.linux-amd64.tar.gz' | shasum -a256 -c - && \
S
Stan Hu 已提交
150
      sudo tar -C /usr/local -xzf go1.5.3.linux-amd64.tar.gz
151
    sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/
S
Stan Hu 已提交
152
    rm go1.5.3.linux-amd64.tar.gz
153 154

## 4. System Users
R
Riyad Preukschas 已提交
155

156
Create a `git` user for GitLab:
157

D
Dmitriy Zaporozhets 已提交
158
    sudo adduser --disabled-login --gecos 'GitLab' git
V
Valery Sizov 已提交
159

160
## 5. Database
R
randx 已提交
161

162 163
We recommend using a PostgreSQL database. For MySQL check the
[MySQL setup guide](database_mysql.md).
164

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

167 168 169 170 171 172 173 174 175
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
176
    sudo -u postgres psql -d template1 -c "CREATE USER git CREATEDB;"
177
    ```
178

179
1. Create the `pg_trgm` extension (required for GitLab 8.6+):
180 181

    ```bash
182
    sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;"
183 184
    ```

185
1. Create the GitLab production database and grant all privileges on database:
186 187

    ```bash
188
    sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;"
189
    ```
190

191 192 193
1. Try connecting to the new database with the new user:

    ```bash
194
    sudo -u git -H psql -d gitlabhq_production
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
    ```

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:
216

217
    ```bash
218
    gitlabhq_production> \q
219
    ```
R
randx 已提交
220

221
## 6. Redis
J
Jacob Vosmaer 已提交
222

223
GitLab requires at least Redis 2.8.
224

225 226
If you are using Debian 8 or Ubuntu 14.04 and up, then you can simply install
Redis 2.8 with:
227 228

```sh
229 230
sudo apt-get install redis-server
```
231

232 233 234
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.
235

236
```
237 238
# Configure redis to use sockets
sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig
239

240 241
# 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
J
Jacob Vosmaer 已提交
242

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

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

249 250 251 252
# Create the directory which contains the socket
mkdir /var/run/redis
chown redis:redis /var/run/redis
chmod 755 /var/run/redis
H
Hugo Osvaldo Barrera 已提交
253

254 255 256 257
# 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
J
Jacob Vosmaer 已提交
258

259
# Activate the changes to redis.conf
260
sudo service redis-server restart
J
Jacob Vosmaer 已提交
261

262 263 264
# Add git to the redis group
sudo usermod -aG redis git
```
J
Jacob Vosmaer 已提交
265

266
## 7. GitLab
V
Valery Sizov 已提交
267

D
Dmitriy Zaporozhets 已提交
268 269
    # We'll install GitLab into home directory of the user "git"
    cd /home/git
270

271
### Clone the Source
R
randx 已提交
272

D
Dmitriy Zaporozhets 已提交
273
    # Clone GitLab repository
274
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 8-14-stable gitlab
D
Dmitriy Zaporozhets 已提交
275

276
**Note:** You can change `8-14-stable` to `master` if you want the *bleeding edge* version, but never install master on a production server!
277

B
Ben Bodenmiller 已提交
278
### Configure It
R
randx 已提交
279

280
    # Go to GitLab installation folder
D
Dmitriy Zaporozhets 已提交
281
    cd /home/git/gitlab
282

R
Riyad Preukschas 已提交
283
    # Copy the example GitLab config
D
Dmitriy Zaporozhets 已提交
284
    sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml
V
Valery Sizov 已提交
285

B
Ben Bodenmiller 已提交
286
    # Update GitLab config file, follow the directions at top of file
S
Sytse Sijbrandij 已提交
287
    sudo -u git -H editor config/gitlab.yml
288

289 290 291
    # 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
292

R
Riyad Preukschas 已提交
293
    # Make sure GitLab can write to the log/ and tmp/ directories
294 295
    sudo chown -R git log/
    sudo chown -R git tmp/
296
    sudo chmod -R u+rwX,go-w log/
297
    sudo chmod -R u+rwX tmp/
R
Riyad Preukschas 已提交
298

299 300 301
    # 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/
302

303 304 305
    # Create the public/uploads/ directory
    sudo -u git -H mkdir public/uploads/

306 307
    # Make sure only the GitLab user has access to the public/uploads/ directory
    # now that files in public/uploads are served by gitlab-workhorse
308
    sudo chmod 0700 public/uploads
309

310 311
    # Change the permissions of the directory where CI build traces are stored
    sudo chmod -R u+rwX builds/
312

K
Kamil Trzcinski 已提交
313 314 315
    # Change the permissions of the directory where CI artifacts are stored
    sudo chmod -R u+rwX shared/artifacts/

316
    # Copy the example Unicorn config
317
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
A
Andrey Kumanyaev 已提交
318

319 320
    # Find number of cores
    nproc
321

322
    # Enable cluster mode if you expect to have a high load instance
323
    # Set the number of workers to at least the number of cores
V
Vincent Lequertier 已提交
324
    # Ex. change amount of workers to 3 for 2GB RAM server
L
Lukas Elmer 已提交
325
    sudo -u git -H editor config/unicorn.rb
326

M
Marin Jankovski 已提交
327 328 329
    # Copy the example Rack attack config
    sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb

J
Jacob Vosmaer 已提交
330 331
    # Configure Git global settings for git user
    # 'autocrlf' is needed for the web editor
332 333
    sudo -u git -H git config --global core.autocrlf input

J
Jacob Vosmaer 已提交
334 335 336
    # Disable 'git gc --auto' because GitLab already runs 'git gc' when needed
    sudo -u git -H git config --global gc.auto 0

J
Jacob Vosmaer 已提交
337 338 339
    # Enable packfile bitmaps
    sudo -u git -H git config --global repack.writeBitmaps true

J
Jacob Vosmaer 已提交
340 341 342
    # Configure Redis connection settings
    sudo -u git -H cp config/resque.yml.example config/resque.yml

343
    # Change the Redis socket path if you are not using the default Debian / Ubuntu configuration
J
Jacob Vosmaer 已提交
344 345
    sudo -u git -H editor config/resque.yml

346
**Important Note:** Make sure to edit both `gitlab.yml` and `unicorn.rb` to match your setup.
R
Riyad Preukschas 已提交
347

B
Ben Bodenmiller 已提交
348 349
**Note:** If you want to use HTTPS, see [Using HTTPS](#using-https) for the additional steps.

B
Ben Bodenmiller 已提交
350
### Configure GitLab DB Settings
351

352
    # PostgreSQL only:
353
    sudo -u git cp config/database.yml.postgresql config/database.yml
354

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

358
    # MySQL and remote PostgreSQL only:
359
    # Update username/password in config/database.yml.
360
    # You only need to adapt the production settings (first part).
361
    # If you followed the database guide then please do as follows:
362 363
    # Change 'secure password' with the value you have given to $password
    # You can keep the double quotes around the password
S
Sytse Sijbrandij 已提交
364
    sudo -u git -H editor config/database.yml
365

366
    # PostgreSQL and MySQL:
367 368
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml
369

370
### Install Gems
371

372
**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.
373

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

377
    # Or if you use MySQL (note, the option says "without ... postgres")
378 379 380
    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.
381

B
Ben Bodenmiller 已提交
382
### Install GitLab Shell
383

384
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
385 386

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

B
Ben Bodenmiller 已提交
389
    # By default, the gitlab-shell config is generated from your main GitLab config.
390
    # You can review (and modify) the gitlab-shell config as follows:
391
    sudo -u git -H editor /home/git/gitlab-shell/config.yml
392

B
Ben Bodenmiller 已提交
393
**Note:** If you want to use HTTPS, see [Using HTTPS](#using-https) for the additional steps.
394

395
**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)".
396

397
### Install gitlab-workhorse
398

399 400 401
GitLab-Workhorse uses [GNU Make](https://www.gnu.org/software/make/). The
following command-line will install GitLab-Workhorse in `home/git/gitlab-workhorse`
which is the recommended location.
J
Jacob Vosmaer 已提交
402

403 404 405 406 407 408 409 410
    cd /home/git/gitlab

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

You can specify a different Git repository by providing `GITLAB_WORKHORSE_REPO`:

    cd /home/git/gitlab

411
    sudo -u git -H bundle exec rake gitlab:workhorse:install[/home/git/gitlab-workhorse] GITLAB_WORKHORSE_REPO=https://example.com/gitlab-workhorse.git RAILS_ENV=production
412 413 414 415 416 417

You can specify a different version to use by providing `GITLAB_WORKHORSE_VERSION`:

    cd /home/git/gitlab

    sudo -u git -H bundle exec rake gitlab:workhorse:install[/home/git/gitlab-workhorse] GITLAB_WORKHORSE_VERSION=0.8.1 RAILS_ENV=production
418

419
### Initialize Database and Activate Advanced Features
420

421
    # Go to GitLab installation folder
422

M
mutec 已提交
423
    cd /home/git/gitlab
424 425 426 427 428 429 430

    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:'

431
**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.
432

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

435 436 437 438 439 440
### 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.

441
### Install Init Script
442

B
Ben Bodenmiller 已提交
443
Download the init script (will be `/etc/init.d/gitlab`):
444

445
    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
R
Rovanion Luckey 已提交
446 447 448 449

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
450

B
Ben Bodenmiller 已提交
451
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.
452 453 454 455 456

Make GitLab start on boot:

    sudo update-rc.d gitlab defaults 21

457
### Setup Logrotate
458 459

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

461
### Check Application Status
R
Robert Speicher 已提交
462

463
Check if GitLab and its environment are configured correctly:
464

D
Dmitriy Zaporozhets 已提交
465
    sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
466

467
### Compile Assets
468 469 470

    sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production

471
### Start Your GitLab Instance
472 473 474 475 476

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

477
## 8. Nginx
V
Valery Sizov 已提交
478

479
**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/).
480

481
### Installation
482

483
    sudo apt-get install -y nginx
484

485
### Site Configuration
R
Riyad Preukschas 已提交
486

487
Copy the example site config:
R
Riyad Preukschas 已提交
488

489
    sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
490
    sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
V
Valery Sizov 已提交
491

492
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:
R
Riyad Preukschas 已提交
493

494 495
    # Change YOUR_SERVER_FQDN to the fully-qualified
    # domain name of your host serving GitLab.
496 497 498 499
    #
    # Remember to match your paths to GitLab, especially
    # if installing for a user other than 'git'.
    #
500 501
    # If using Ubuntu default nginx install:
    # either remove the default_server from the listen line
D
Douwe Maan 已提交
502
    # or else sudo rm -f /etc/nginx/sites-enabled/default
S
Sytse Sijbrandij 已提交
503
    sudo editor /etc/nginx/sites-available/gitlab
D
Dmitriy Zaporozhets 已提交
504

B
Ben Bodenmiller 已提交
505
**Note:** If you want to use HTTPS, replace the `gitlab` Nginx config with `gitlab-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details.
B
Ben Bodenmiller 已提交
506 507 508 509 510 511

### Test Configuration

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

    sudo nginx -t
512

C
Ciro Santilli 已提交
513
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.
514

515
### Restart
R
Riyad Preukschas 已提交
516

517
    sudo service nginx restart
D
Dmitriy Zaporozhets 已提交
518

519
## Done!
520

521
### Double-check Application Status
522 523 524 525 526 527 528

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!

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

531
### Initial Login
532

533
Visit YOUR_SERVER in your web browser for your first GitLab login.
V
Valery Sizov 已提交
534

535 536 537 538
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.
539

540 541
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.
R
Riyad Preukschas 已提交
542 543 544

**Enjoy!**

545 546
You can use `sudo service gitlab start` and `sudo service gitlab stop` to start and stop GitLab.

547
## Advanced Setup Tips
V
Valery Sizov 已提交
548

549 550 551
### Relative URL support

See the [Relative URL documentation](relative_url.md) for more information on
A
Achilleas Pipinellis 已提交
552
how to configure GitLab with a relative URL.
553

554 555
### Using HTTPS

B
Ben Bodenmiller 已提交
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
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:

B
Ben Bodenmiller 已提交
571
1. Generate a self-signed SSL certificate:
572

B
Ben Bodenmiller 已提交
573 574 575 576 577 578 579
    ```
    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`.
580

581
### Enable Reply by email
V
Valery Sizov 已提交
582

583
See the ["Reply by email" documentation](../administration/reply_by_email.md) for more information on how to set this up.
584 585 586 587 588 589 590 591 592 593 594 595

### 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.
R
Robert Schilling 已提交
596
Checkout the [GitLab Runner section](https://about.gitlab.com/gitlab-ci/#gitlab-runner) to install it
597

598 599 600 601 602 603 604
### 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`
605 606
option in section 1. Save the file and [reconfigure GitLab](../administration/restart_gitlab.md)
for the changes to take effect.
607

608
### Custom Redis Connection
609

610
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.
611

R
Riyad Preukschas 已提交
612
    # example
613
    production:
614
      url: redis://redis.example.tld:6379
615

616
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.
617 618

    # example
619
    production:
620
      url: unix:/path/to/redis/socket
621

622
### Custom SSH Connection
623

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

D
Dmitriy Zaporozhets 已提交
626
    # Add to /home/git/.ssh/config
627 628 629 630
    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
631

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

634
### Additional Markup Styles
635

636
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.
637 638 639 640 641 642

## Troubleshooting

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

If you see this message when attempting to clone a repository hosted by GitLab,
643
this is likely due to an outdated Nginx or Apache configuration, or a missing or
644 645
misconfigured gitlab-workhorse instance. Double-check that you've
[installed Go](#3-go), [installed gitlab-workhorse](#install-gitlab-workhorse),
646
and correctly [configured Nginx](#site-configuration).
647 648 649 650

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