installation.md 24.7 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 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's avatar
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).
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
34

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

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

Riyad Preukschas's avatar
Riyad Preukschas committed
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
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
    # run as root!
    apt-get update -y
    apt-get upgrade -y
    apt-get install sudo -y
Valery Sizov's avatar
Valery Sizov committed
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

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

dosire's avatar
dosire committed
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/
Ben Bodenmiller's avatar
Ben Bodenmiller committed
95
    ./configure
96 97 98 99 100
    make prefix=/usr/local all

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

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
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
Valery Sizov's avatar
Valery Sizov committed
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.
dosire's avatar
dosire committed
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
Valery Sizov's avatar
Valery Sizov committed
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
    curl --remote-name --progress https://storage.googleapis.com/golang/go1.5.3.linux-amd64.tar.gz
146
    echo '43afe0c5017e502630b1aea4d44b8a7f059bf60d7f29dfd58db454d4e4e0ae53  go1.5.3.linux-amd64.tar.gz' | shasum -a256 -c - && \
Stan Hu's avatar
Stan Hu committed
147
      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/
Stan Hu's avatar
Stan Hu committed
149
    rm go1.5.3.linux-amd64.tar.gz
150 151

## 4. System Users
Riyad Preukschas's avatar
Riyad Preukschas committed
152

153
Create a `git` user for GitLab:
154

155
    sudo adduser --disabled-login --gecos 'GitLab' git
Valery Sizov's avatar
Valery Sizov committed
156

157
## 5. Database
randx's avatar
randx committed
158

159 160
We recommend using a PostgreSQL database. For MySQL check the
[MySQL setup guide](database_mysql.md).
161

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

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

176 177 178
1. Create the GitLab production database and grant all privileges on database:

    ```bash
179
    sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;"
180 181 182 183 184 185 186
    ```

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

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

188 189 190
1. Try connecting to the new database with the new user:

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

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

214
    ```bash
215
    gitlabhq_production> \q
216
    ```
randx's avatar
randx committed
217

218
## 6. Redis
219

220
GitLab requires at least Redis 2.8.
221

222 223
If you are using Debian 8 or Ubuntu 14.04 and up, then you can simply install
Redis 2.8 with:
224 225

```sh
226 227
sudo apt-get install redis-server
```
228

229 230 231
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.
232

233
```
234 235
# Configure redis to use sockets
sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig
236

237 238
# 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
239

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

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

246 247 248 249
# 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
250

251 252 253 254
# 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
255

256
# Activate the changes to redis.conf
257
sudo service redis-server restart
258

259 260 261
# Add git to the redis group
sudo usermod -aG redis git
```
262

263
## 7. GitLab
Valery Sizov's avatar
Valery Sizov committed
264

265 266
    # We'll install GitLab into home directory of the user "git"
    cd /home/git
267

268
### Clone the Source
randx's avatar
randx committed
269

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
270
    # Clone GitLab repository
271
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 8-13-stable gitlab
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
272

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
275
### Configure It
randx's avatar
randx committed
276

277
    # Go to GitLab installation folder
278
    cd /home/git/gitlab
279

Riyad Preukschas's avatar
Riyad Preukschas committed
280
    # Copy the example GitLab config
281
    sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml
Valery Sizov's avatar
Valery Sizov committed
282

283
    # Update GitLab config file, follow the directions at top of file
284
    sudo -u git -H editor config/gitlab.yml
285

286 287 288
    # 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
289

Riyad Preukschas's avatar
Riyad Preukschas committed
290
    # Make sure GitLab can write to the log/ and tmp/ directories
291 292
    sudo chown -R git log/
    sudo chown -R git tmp/
293
    sudo chmod -R u+rwX,go-w log/
294
    sudo chmod -R u+rwX tmp/
Riyad Preukschas's avatar
Riyad Preukschas committed
295

296 297 298
    # 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/
299

300 301 302
    # Create the public/uploads/ directory
    sudo -u git -H mkdir public/uploads/

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

307 308
    # Change the permissions of the directory where CI build traces are stored
    sudo chmod -R u+rwX builds/
309

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

313
    # Copy the example Unicorn config
314
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
315

316 317
    # Find number of cores
    nproc
318

319
    # Enable cluster mode if you expect to have a high load instance
320
    # Set the number of workers to at least the number of cores
321
    # Ex. change amount of workers to 3 for 2GB RAM server
Lukas Elmer's avatar
Lukas Elmer committed
322
    sudo -u git -H editor config/unicorn.rb
323

324 325 326
    # Copy the example Rack attack config
    sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb

Jacob Vosmaer's avatar
Jacob Vosmaer committed
327 328
    # Configure Git global settings for git user
    # 'autocrlf' is needed for the web editor
329 330
    sudo -u git -H git config --global core.autocrlf input

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

334 335 336
    # Enable packfile bitmaps
    sudo -u git -H git config --global repack.writeBitmaps true

337 338 339
    # Configure Redis connection settings
    sudo -u git -H cp config/resque.yml.example config/resque.yml

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

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

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
347
### Configure GitLab DB Settings
348

349
    # PostgreSQL only:
350
    sudo -u git cp config/database.yml.postgresql config/database.yml
351

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

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

363
    # PostgreSQL and MySQL:
364 365
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml
366

367
### Install Gems
368

369
**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.
370

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

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
379
### Install GitLab Shell
380

381
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
382 383

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

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

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

392
**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)".
393

394
### Install gitlab-workhorse
395

Jacob Vosmaer's avatar
Jacob Vosmaer committed
396 397 398 399
GitLab-Workhorse uses [GNU Make](https://www.gnu.org/software/make/).
If you are not using Linux you may have to run `gmake` instead of
`make` below.

400
    cd /home/git
401 402
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-workhorse.git
    cd gitlab-workhorse
Nick Thomas's avatar
Nick Thomas committed
403
    sudo -u git -H git checkout v0.8.5
404 405
    sudo -u git -H make

406
### Initialize Database and Activate Advanced Features
407

408
    # Go to GitLab installation folder
409

mutec's avatar
mutec committed
410
    cd /home/git/gitlab
411 412 413 414 415 416 417

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

418
**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.
419

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

422 423 424 425 426 427
### 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.

428
### Install Init Script
429

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

432
    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
433 434 435 436

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
437

Ben Bodenmiller's avatar
Ben Bodenmiller committed
438
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.
439 440 441 442 443

Make GitLab start on boot:

    sudo update-rc.d gitlab defaults 21

444
### Setup Logrotate
445 446

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

448
### Check Application Status
449

450
Check if GitLab and its environment are configured correctly:
451

452
    sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
453

454
### Compile Assets
455 456 457

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

458
### Start Your GitLab Instance
459 460 461 462 463

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

464
## 8. Nginx
Valery Sizov's avatar
Valery Sizov committed
465

466
**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/).
467

468
### Installation
469

470
    sudo apt-get install -y nginx
471

472
### Site Configuration
Riyad Preukschas's avatar
Riyad Preukschas committed
473

474
Copy the example site config:
Riyad Preukschas's avatar
Riyad Preukschas committed
475

476
    sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
477
    sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
Valery Sizov's avatar
Valery Sizov committed
478

Riyad Preukschas's avatar
Riyad Preukschas committed
479 480
Make sure to edit the config file to match your setup:

481 482
    # Change YOUR_SERVER_FQDN to the fully-qualified
    # domain name of your host serving GitLab.
483 484
    # If using Ubuntu default nginx install:
    # either remove the default_server from the listen line
Douwe Maan's avatar
Douwe Maan committed
485
    # or else sudo rm -f /etc/nginx/sites-enabled/default
486
    sudo editor /etc/nginx/sites-available/gitlab
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
487

488
**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
489 490 491 492 493 494

### Test Configuration

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

    sudo nginx -t
495

496
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.
497

498
### Restart
Riyad Preukschas's avatar
Riyad Preukschas committed
499

500
    sudo service nginx restart
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
501

502
## Done!
503

504
### Double-check Application Status
505 506 507 508 509 510 511

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!

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

514
### Initial Login
515

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

518 519 520 521
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.
522

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

**Enjoy!**

528 529
You can use `sudo service gitlab start` and `sudo service gitlab stop` to start and stop GitLab.

530
## Advanced Setup Tips
Valery Sizov's avatar
Valery Sizov committed
531

532 533 534
### Relative URL support

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

537 538
### Using HTTPS

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
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
554
1. Generate a self-signed SSL certificate:
555

Ben Bodenmiller's avatar
Ben Bodenmiller committed
556 557 558 559 560 561 562
    ```
    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`.
563

564
### Enable Reply by email
Valery Sizov's avatar
Valery Sizov committed
565

566
See the ["Reply by email" documentation](../administration/reply_by_email.md) for more information on how to set this up.
567 568 569 570 571 572 573 574 575 576 577 578

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

581 582 583 584 585 586 587
### 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`
588 589
option in section 1. Save the file and [reconfigure GitLab](../administration/restart_gitlab.md)
for the changes to take effect.
590

591
### Custom Redis Connection
592

593
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.
594

Riyad Preukschas's avatar
Riyad Preukschas committed
595
    # example
596
    production:
597
      url: redis://redis.example.tld:6379
598

599
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.
600 601

    # example
602
    production:
603
      url: unix:/path/to/redis/socket
604

605
### Custom SSH Connection
606

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

609
    # Add to /home/git/.ssh/config
610 611 612 613
    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
614

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

617
### Additional Markup Styles
618

619
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.
620 621 622 623 624 625

## Troubleshooting

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

If you see this message when attempting to clone a repository hosted by GitLab,
626
this is likely due to an outdated Nginx or Apache configuration, or a missing or
627 628
misconfigured gitlab-workhorse instance. Double-check that you've
[installed Go](#3-go), [installed gitlab-workhorse](#install-gitlab-workhorse),
629
and correctly [configured Nginx](#site-configuration).
630 631 632 633

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