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

3 4 5 6
## Consider the Omnibus package installation

Since a manual installation 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).

7 8
## Select Version to Install

9
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.
10 11
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).
12

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

15
## Important Notes
Valery Sizov's avatar
Valery Sizov committed
16

17 18
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).

19
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/).
20

21
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).
22

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

25
If you find a bug/error in this guide please **submit a merge request** following the [contributing guide](../../CONTRIBUTING.md).
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
26

27
## Overview
Valery Sizov's avatar
Valery Sizov committed
28

29
The GitLab installation consists of setting up the following components:
30

Riyad Preukschas's avatar
Riyad Preukschas committed
31
1. Packages / Dependencies
32 33 34
1. Ruby
1. System Users
1. Database
35
1. Redis
36 37
1. GitLab
1. Nginx
Valery Sizov's avatar
Valery Sizov committed
38

39
## 1. Packages / Dependencies
Valery Sizov's avatar
Valery Sizov committed
40

41 42
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
43

44 45 46 47
    # run as root!
    apt-get update -y
    apt-get upgrade -y
    apt-get install sudo -y
Valery Sizov's avatar
Valery Sizov committed
48

49
**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.
50

51
    # Install vim and set as default editor
52
    sudo apt-get install -y vim
53
    sudo update-alternatives --set editor /usr/bin/vim.basic
54

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

Valery Sizov's avatar
Valery Sizov committed
57
    sudo apt-get install -y build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libreadline-dev libncurses5-dev libffi-dev curl openssh-server redis-server checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libicu-dev logrotate python-docutils pkg-config cmake libkrb5-dev
58

59 60 61 62 63
Make sure you have the right version of Git installed

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

64
    # Make sure Git is version 1.7.10 or higher, for example 1.7.12 or 2.0.0
65 66
    git --version

67
Is the system packaged Git too old? Remove it and compile from source.
68 69 70 71 72

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

    # Install dependencies
73
    sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential
74 75 76

    # Download and compile from source
    cd /tmp
Valery Sizov's avatar
Valery Sizov committed
77 78
    curl -L --progress https://www.kernel.org/pub/software/scm/git/git-2.1.2.tar.gz | tar xz
    cd git-2.1.2/
Ben Bodenmiller's avatar
Ben Bodenmiller committed
79
    ./configure
80 81 82 83 84
    make prefix=/usr/local all

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

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
87
**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:
88

89
    sudo apt-get install -y postfix
90 91

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

93
## 2. Ruby
Valery Sizov's avatar
Valery Sizov committed
94

Ben Bodenmiller's avatar
Ben Bodenmiller committed
95
The use of Ruby version managers such as [RVM](http://rvm.io/), [rbenv](https://github.com/sstephenson/rbenv) or [chruby](https://github.com/postmodern/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.
dosire's avatar
dosire committed
96

97
Remove the old Ruby 1.8 if present
98

99
    sudo apt-get remove ruby1.8
100

101
Download Ruby and compile it:
102

103
    mkdir /tmp/ruby && cd /tmp/ruby
104 105
    curl -L --progress http://cache.ruby-lang.org/pub/ruby/2.1/ruby-2.1.5.tar.gz | tar xz
    cd ruby-2.1.5
106
    ./configure --disable-install-rdoc
Valery Sizov's avatar
Valery Sizov committed
107 108 109
    make
    sudo make install

110 111
Install the Bundler Gem:

112
    sudo gem install bundler --no-ri --no-rdoc
113

114
## 3. System Users
Riyad Preukschas's avatar
Riyad Preukschas committed
115

116
Create a `git` user for GitLab:
117

118
    sudo adduser --disabled-login --gecos 'GitLab' git
Valery Sizov's avatar
Valery Sizov committed
119

120
## 4. Database
randx's avatar
randx committed
121

122
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.
123 124

    # Install the database packages
125
    sudo apt-get install -y postgresql postgresql-client libpq-dev
126 127 128 129

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

130 131
    # Create a user for GitLab
    # Do not type the 'template1=#', this is part of the prompt
132
    template1=# CREATE USER git CREATEDB;
133 134 135 136 137 138 139 140 141

    # 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
142 143 144
    
    # Quit the database session
    gitlabhq_production> \q
randx's avatar
randx committed
145

146 147 148 149 150 151
## 5. Redis

    sudo apt-get install redis-server

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

153 154 155 156 157
    # 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

    # Enable Redis socket for default Debian / Ubuntu path
    echo 'unixsocket /var/run/redis/redis.sock' | sudo tee -a /etc/redis/redis.conf
Hugo Osvaldo Barrera's avatar
Hugo Osvaldo Barrera committed
158 159 160 161 162 163 164 165 166 167 168
    # Grant permission to the socket to all members of the redis group
    echo 'unixsocketperm 770' | sudo tee -a /etc/redis/redis.conf

    # Create the directory which contains the socket
    mkdir /var/run/redis
    chown redis:redis /var/run/redis
    chmod 755 /var/run/redis
    # 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
169 170 171 172 173 174 175 176

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

    # Add git to the redis group
    sudo usermod -aG redis git

## 6. GitLab
Valery Sizov's avatar
Valery Sizov committed
177

178 179
    # We'll install GitLab into home directory of the user "git"
    cd /home/git
180

181
### Clone the Source
randx's avatar
randx committed
182

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
183
    # Clone GitLab repository
184
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 7-5-stable gitlab
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
185

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
188
### Configure It
randx's avatar
randx committed
189

190
    # Go to GitLab installation folder
191
    cd /home/git/gitlab
192

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

196
    # Update GitLab config file, follow the directions at top of file
197
    sudo -u git -H editor config/gitlab.yml
198

Riyad Preukschas's avatar
Riyad Preukschas committed
199
    # Make sure GitLab can write to the log/ and tmp/ directories
200 201
    sudo chown -R git log/
    sudo chown -R git tmp/
202
    sudo chmod -R u+rwX,go-w log/
203
    sudo chmod -R u+rwX tmp/
Riyad Preukschas's avatar
Riyad Preukschas committed
204

205
    # Create directory for satellites
206
    sudo -u git -H mkdir /home/git/gitlab-satellites
Michael  Krane's avatar
Michael Krane committed
207
    sudo chmod u+rwx,g=rx,o-rwx /home/git/gitlab-satellites
208

209 210 211
    # 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/
212

213
    # Make sure GitLab can write to the public/uploads/ directory
214 215
    sudo chmod -R u+rwX  public/uploads

216
    # Copy the example Unicorn config
217
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
218

219 220
    # Find number of cores
    nproc
221

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

227 228 229
    # Copy the example Rack attack config
    sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb

230 231 232
    # Configure Git global settings for git user, useful when editing via web
    # Edit user.email according to what is set in gitlab.yml
    sudo -u git -H git config --global user.name "GitLab"
233
    sudo -u git -H git config --global user.email "example@example.com"
234
    sudo -u git -H git config --global core.autocrlf input
235

236 237 238
    # Configure Redis connection settings
    sudo -u git -H cp config/resque.yml.example config/resque.yml

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

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

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
246
### Configure GitLab DB Settings
247

248
    # PostgreSQL only:
249
    sudo -u git cp config/database.yml.postgresql config/database.yml
250

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

254
    # MySQL and remote PostgreSQL only:
255
    # Update username/password in config/database.yml.
256
    # You only need to adapt the production settings (first part).
257
    # If you followed the database guide then please do as follows:
258 259
    # Change 'secure password' with the value you have given to $password
    # You can keep the double quotes around the password
260
    sudo -u git -H editor config/database.yml
261

262
    # PostgreSQL and MySQL:
263 264
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml
265

266
### Install Gems
267

268
**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](http://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.
269

270
    # For PostgreSQL (note, the option says "without ... mysql")
271
    sudo -u git -H bundle install --deployment --without development test mysql aws
272

273 274 275
    # Or if you use MySQL (note, the option says "without ... postgres")
    sudo -u git -H bundle install --deployment --without development test postgres aws

Ben Bodenmiller's avatar
Ben Bodenmiller committed
276
### Install GitLab Shell
277

278
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
279 280

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

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

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

289
### Initialize Database and Activate Advanced Features
290 291 292 293 294 295 296

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

297 298 299 300
**Note:** You can set the Administrator password by supplying it in environmental variable `GITLAB_ROOT_PASSWORD`, eg.:

    sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=newpassword

301
### Install Init Script
302

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

305
    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
306 307 308 309

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
310

Ben Bodenmiller's avatar
Ben Bodenmiller committed
311
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.
312 313 314 315 316

Make GitLab start on boot:

    sudo update-rc.d gitlab defaults 21

317
### Setup Logrotate
318 319

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

321
### Check Application Status
322

323
Check if GitLab and its environment are configured correctly:
324

325
    sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
326

327
### Compile Assets
328 329 330

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

331
### Start Your GitLab Instance
332 333 334 335 336

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

337
## 7. Nginx
Valery Sizov's avatar
Valery Sizov committed
338

339
**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/).
340

341
### Installation
342

343
    sudo apt-get install -y nginx
344

345
### Site Configuration
Riyad Preukschas's avatar
Riyad Preukschas committed
346

347
Copy the example site config:
Riyad Preukschas's avatar
Riyad Preukschas committed
348

349
    sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
350
    sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
Valery Sizov's avatar
Valery Sizov committed
351

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

354 355
    # Change YOUR_SERVER_FQDN to the fully-qualified
    # domain name of your host serving GitLab.
356
    sudo editor /etc/nginx/sites-available/gitlab
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
357

358
**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
359 360 361 362 363 364

### Test Configuration

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

    sudo nginx -t
365

366
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.
367

368
### Restart
Riyad Preukschas's avatar
Riyad Preukschas committed
369

370
    sudo service nginx restart
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
371

372
## Done!
373

374
### Double-check Application Status
375 376 377 378 379 380 381

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!

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

384
### Initial Login
385

386
Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has created an admin account for you. You can use it to log in:
Valery Sizov's avatar
Valery Sizov committed
387

388
    root
389
    5iveL!fe
390

391
**Important Note:** Please go over to your profile page and immediately change the password, so nobody can access your GitLab by using this login information later on.
Riyad Preukschas's avatar
Riyad Preukschas committed
392 393 394

**Enjoy!**

395
## Advanced Setup Tips
Valery Sizov's avatar
Valery Sizov committed
396

397 398
### Using HTTPS

399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
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
414
1. Generate a self-signed SSL certificate:
415

Ben Bodenmiller's avatar
Ben Bodenmiller committed
416 417 418 419 420 421 422
    ```
    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`.
423

424
### Additional Markup Styles
Valery Sizov's avatar
Valery Sizov committed
425

426
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.
427

428
### Custom Redis Connection
429

430
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.
431

Riyad Preukschas's avatar
Riyad Preukschas committed
432
    # example
433
    production: redis://redis.example.tld:6379
434

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

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

440
### Custom SSH Connection
441

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

444
    # Add to /home/git/.ssh/config
445 446 447 448
    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
449

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

452
### LDAP Authentication
453

454
You can configure LDAP authentication in `config/gitlab.yml`. Please restart GitLab after editing this file.
455 456 457 458

### Using Custom Omniauth Providers

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