installation.md 22.8 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 9 10 11 12
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.
Omnibus packages solve this by [letting the Sidekiq terminate gracefully](http://doc.gitlab.com/ce/operations/sidekiq_memory_killer.html) if it uses too much memory.
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 [doc/install/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 1.7.10 or higher, for example 1.7.12 or 2.0.0
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
J
Jacob Vosmaer 已提交
92 93
    curl -L --progress https://www.kernel.org/pub/software/scm/git/git-2.4.3.tar.gz | tar xz
    cd git-2.4.3/
B
Ben Bodenmiller 已提交
94
    ./configure
95 96 97 98 99
    make prefix=/usr/local all

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

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

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

104
    sudo apt-get install -y postfix
105 106

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

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

110
_**Note:** The current supported Ruby versions are 2.1.x and 2.2.x. Ruby 2.3 is
111
currently not supported._
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
    curl -O --progress https://cache.ruby-lang.org/pub/ruby/2.2/ruby-2.2.4.tar.gz
127
    echo 'b6eff568b48e0fda76e5a36333175df049b204e91217aa32a65153cc0cdcb761  ruby-2.2.4.tar.gz' | sha256sum -c - && tar xzf ruby-2.2.4.tar.gz
128
    cd ruby-2.2.4
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

S
Stan Hu 已提交
145 146 147
    curl -O --progress https://storage.googleapis.com/golang/go1.5.3.linux-amd64.tar.gz
    echo '43afe0c5017e502630b1aea4d44b8a7f059bf60d7f29dfd58db454d4e4e0ae53  go1.5.3.linux-amd64.tar.gz' | shasum -c - && \
      sudo tar -C /usr/local -xzf go1.5.3.linux-amd64.tar.gz
148
    sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/
S
Stan Hu 已提交
149
    rm go1.5.3.linux-amd64.tar.gz
150 151

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

153
Create a `git` user for GitLab:
154

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

157
## 5. Database
R
randx 已提交
158

159
We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](database_mysql.md). *Note*: because we need to make use of extensions you need at least pgsql 9.1.
160 161

    # Install the database packages
162
    sudo apt-get install -y postgresql postgresql-client libpq-dev
163 164 165 166

    # Login to PostgreSQL
    sudo -u postgres psql -d template1

167 168
    # Create a user for GitLab
    # Do not type the 'template1=#', this is part of the prompt
169
    template1=# CREATE USER git CREATEDB;
170 171 172 173 174 175 176 177 178

    # Create the GitLab production database & grant all privileges on database
    template1=# CREATE DATABASE gitlabhq_production OWNER git;

    # Quit the database session
    template1=# \q

    # Try connecting to the new database with the new user
    sudo -u git -H psql -d gitlabhq_production
179

180 181
    # Quit the database session
    gitlabhq_production> \q
R
randx 已提交
182

183
## 6. Redis
J
Jacob Vosmaer 已提交
184

185
As of this writing, most Debian/Ubuntu distributions ship with Redis 2.2 or
186
2.4. GitLab requires at least Redis 2.8.
187

188
Ubuntu users [can use a PPA](https://launchpad.net/~chris-lea/+archive/ubuntu/redis-server)
189 190
to install a recent version of Redis.

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
The following instructions cover building and installing Redis from scratch:

```sh
# Build Redis
wget http://download.redis.io/releases/redis-2.8.23.tar.gz
tar xzf redis-2.8.23.tar.gz
cd redis-2.8.23
make

# Install Redis
cd utils
sudo ./install_server.sh

# Configure redis to use sockets
sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig
206

207 208
# 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 已提交
209

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

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

216 217 218 219
# 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 已提交
220

221 222 223 224
# 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 已提交
225

226 227
# Activate the changes to redis.conf
sudo service redis_6379 start
J
Jacob Vosmaer 已提交
228

229 230 231
# Add git to the redis group
sudo usermod -aG redis git
```
J
Jacob Vosmaer 已提交
232

233
## 7. GitLab
V
Valery Sizov 已提交
234

D
Dmitriy Zaporozhets 已提交
235 236
    # We'll install GitLab into home directory of the user "git"
    cd /home/git
237

238
### Clone the Source
R
randx 已提交
239

D
Dmitriy Zaporozhets 已提交
240
    # Clone GitLab repository
241
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 8-4-stable gitlab
D
Dmitriy Zaporozhets 已提交
242

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

B
Ben Bodenmiller 已提交
245
### Configure It
R
randx 已提交
246

247
    # Go to GitLab installation folder
D
Dmitriy Zaporozhets 已提交
248
    cd /home/git/gitlab
249

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

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

256 257 258
    # 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
259

R
Riyad Preukschas 已提交
260
    # Make sure GitLab can write to the log/ and tmp/ directories
261 262
    sudo chown -R git log/
    sudo chown -R git tmp/
263
    sudo chmod -R u+rwX,go-w log/
264
    sudo chmod -R u+rwX tmp/
R
Riyad Preukschas 已提交
265

266 267 268
    # 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/
269

270 271 272
    # Create the public/uploads/ directory
    sudo -u git -H mkdir public/uploads/

273
    # Make sure GitLab can write to the public/uploads/ directory
274
    sudo chmod -R u+rwX  public/uploads
275

276 277
    # Change the permissions of the directory where CI build traces are stored
    sudo chmod -R u+rwX builds/
278

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

282
    # Copy the example Unicorn config
283
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
A
Andrey Kumanyaev 已提交
284

285 286
    # Find number of cores
    nproc
287

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

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

296 297 298
    # Configure Git global settings for git user, used when editing via web editor
    sudo -u git -H git config --global core.autocrlf input

J
Jacob Vosmaer 已提交
299 300 301
    # Configure Redis connection settings
    sudo -u git -H cp config/resque.yml.example config/resque.yml

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

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

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

B
Ben Bodenmiller 已提交
309
### Configure GitLab DB Settings
310

311
    # PostgreSQL only:
312
    sudo -u git cp config/database.yml.postgresql config/database.yml
313

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

317
    # MySQL and remote PostgreSQL only:
318
    # Update username/password in config/database.yml.
319
    # You only need to adapt the production settings (first part).
320
    # If you followed the database guide then please do as follows:
321 322
    # Change 'secure password' with the value you have given to $password
    # You can keep the double quotes around the password
S
Sytse Sijbrandij 已提交
323
    sudo -u git -H editor config/database.yml
324

325
    # PostgreSQL and MySQL:
326 327
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml
328

329
### Install Gems
330

331
**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.
332

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

336
    # Or if you use MySQL (note, the option says "without ... postgres")
337 338 339
    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.
340

B
Ben Bodenmiller 已提交
341
### Install GitLab Shell
342

343
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
344 345

    # Run the installation task for gitlab-shell (replace `REDIS_URL` if needed):
346
    sudo -u git -H bundle exec rake gitlab:shell:install REDIS_URL=unix:/var/run/redis/redis.sock RAILS_ENV=production
347

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

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

354
**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)".
355

356
### Install gitlab-workhorse
357 358

    cd /home/git
359 360
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-workhorse.git
    cd gitlab-workhorse
361
    sudo -u git -H git checkout 0.6.3
362 363
    sudo -u git -H make

364
### Initialize Database and Activate Advanced Features
365

366
    # Go to GitLab installation folder
367

M
mutec 已提交
368
    cd /home/git/gitlab
369 370 371 372 373 374 375

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

376
**Note:** You can set the Administrator/root password by supplying it in environmental variable `GITLAB_ROOT_PASSWORD` 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.
377

378
    sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword
379

380 381 382 383 384 385
### 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.

386
### Install Init Script
387

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

390
    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
R
Rovanion Luckey 已提交
391 392 393 394

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
395

B
Ben Bodenmiller 已提交
396
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.
397 398 399 400 401

Make GitLab start on boot:

    sudo update-rc.d gitlab defaults 21

402
### Setup Logrotate
403 404

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

406
### Check Application Status
R
Robert Speicher 已提交
407

408
Check if GitLab and its environment are configured correctly:
409

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

412
### Compile Assets
413 414 415

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

416
### Start Your GitLab Instance
417 418 419 420 421

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

422
## 8. Nginx
V
Valery Sizov 已提交
423

424
**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/).
425

426
### Installation
427

428
    sudo apt-get install -y nginx
429

430
### Site Configuration
R
Riyad Preukschas 已提交
431

432
Copy the example site config:
R
Riyad Preukschas 已提交
433

434
    sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
435
    sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
V
Valery Sizov 已提交
436

R
Riyad Preukschas 已提交
437 438
Make sure to edit the config file to match your setup:

439 440
    # Change YOUR_SERVER_FQDN to the fully-qualified
    # domain name of your host serving GitLab.
441 442
    # If using Ubuntu default nginx install:
    # either remove the default_server from the listen line
D
Douwe Maan 已提交
443
    # or else sudo rm -f /etc/nginx/sites-enabled/default
S
Sytse Sijbrandij 已提交
444
    sudo editor /etc/nginx/sites-available/gitlab
D
Dmitriy Zaporozhets 已提交
445

B
Ben Bodenmiller 已提交
446
**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 已提交
447 448 449 450 451 452

### Test Configuration

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

    sudo nginx -t
453

C
Ciro Santilli 已提交
454
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.
455

456
### Restart
R
Riyad Preukschas 已提交
457

458
    sudo service nginx restart
D
Dmitriy Zaporozhets 已提交
459

460
## Done!
461

462
### Double-check Application Status
463 464 465 466 467 468 469

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!

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

472
### Initial Login
473

474
Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has created a default admin account for you. You can use it to log in:
V
Valery Sizov 已提交
475

476
    root
477
    5iveL!fe
478

479
**Important Note:** On login you'll be prompted to change the password.
R
Riyad Preukschas 已提交
480 481 482

**Enjoy!**

483 484
You can use `sudo service gitlab start` and `sudo service gitlab stop` to start and stop GitLab.

485
## Advanced Setup Tips
V
Valery Sizov 已提交
486

487 488
### Using HTTPS

B
Ben Bodenmiller 已提交
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
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 已提交
504
1. Generate a self-signed SSL certificate:
505

B
Ben Bodenmiller 已提交
506 507 508 509 510 511 512
    ```
    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`.
513

514
### Enable Reply by email
V
Valery Sizov 已提交
515

516 517 518 519 520 521 522 523 524 525 526 527 528
See the ["Reply by email" documentation](../incoming_email/README.md) for more information on how to set this up.

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

531
### Custom Redis Connection
532

533
If you'd like Resque 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.
534

R
Riyad Preukschas 已提交
535
    # example
536
    production: redis://redis.example.tld:6379
537

538
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.
539 540 541 542

    # example
    production: unix:/path/to/redis/socket

543
### Custom SSH Connection
544

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

D
Dmitriy Zaporozhets 已提交
547
    # Add to /home/git/.ssh/config
548 549 550 551
    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
552

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

555
### Additional Markup Styles
556

557
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.
558 559 560 561 562 563

## Troubleshooting

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

If you see this message when attempting to clone a repository hosted by GitLab,
564
this is likely due to an outdated Nginx or Apache configuration, or a missing or
565 566
misconfigured gitlab-workhorse instance. Double-check that you've
[installed Go](#3-go), [installed gitlab-workhorse](#install-gitlab-workhorse),
567
and correctly [configured Nginx](#site-configuration).
568 569 570 571

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