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

3 4 5
## Select Version to Install

Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install. In most cases this should be the highest numbered stable branch (example shown below).
6

7
![Select latest branch](https://i.imgur.com/Lrdxk1k.png)
8

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

11
## Important Notes
Valery Sizov's avatar
Valery Sizov committed
12

13 14
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).

15
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://www.gitlab.com/downloads/).
16

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

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

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

23
## Overview
Valery Sizov's avatar
Valery Sizov committed
24

25
The GitLab installation consists of setting up the following components:
26

Riyad Preukschas's avatar
Riyad Preukschas committed
27
1. Packages / Dependencies
28 29 30 31 32
1. Ruby
1. System Users
1. Database
1. GitLab
1. Nginx
Valery Sizov's avatar
Valery Sizov committed
33

34
## 1. Packages / Dependencies
Valery Sizov's avatar
Valery Sizov committed
35

36 37
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
38

39 40 41 42
    # run as root!
    apt-get update -y
    apt-get upgrade -y
    apt-get install sudo -y
Valery Sizov's avatar
Valery Sizov committed
43

44
**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.
45

46
    # Install vim and set as default editor
47
    sudo apt-get install -y vim
48
    sudo update-alternatives --set editor /usr/bin/vim.basic
49

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

52
    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 cmake
53

54 55 56 57 58
Make sure you have the right version of Git installed

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

59
    # Make sure Git is version 1.7.10 or higher, for example 1.7.12 or 2.0.0
60 61
    git --version

62
Is the system packaged Git too old? Remove it and compile from source.
63 64 65 66 67

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

    # Install dependencies
68
    sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential
69 70 71

    # Download and compile from source
    cd /tmp
Ben Bodenmiller's avatar
Ben Bodenmiller committed
72
    curl -L --progress https://www.kernel.org/pub/software/scm/git/git-2.0.0.tar.gz | tar xz
73
    cd git-2.0.0/
74 75 76 77 78
    make prefix=/usr/local all

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

79
    # When editing config/gitlab.yml (Step 5), change the git bin_path to /usr/local/bin/git
80

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

83
    sudo apt-get install -y postfix
84 85

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

87
## 2. Ruby
Valery Sizov's avatar
Valery Sizov committed
88

89
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
90

91
Remove the old Ruby 1.8 if present
92

93
    sudo apt-get remove ruby1.8
94

95
Download Ruby and compile it:
96

97
    mkdir /tmp/ruby && cd /tmp/ruby
Ben Bodenmiller's avatar
Ben Bodenmiller committed
98
    curl -L --progress ftp://ftp.ruby-lang.org/pub/ruby/2.1/ruby-2.1.2.tar.gz | tar xz
99
    cd ruby-2.1.2
100
    ./configure --disable-install-rdoc
Valery Sizov's avatar
Valery Sizov committed
101 102 103
    make
    sudo make install

104 105
Install the Bundler Gem:

106
    sudo gem install bundler --no-ri --no-rdoc
107

108
## 3. System Users
Riyad Preukschas's avatar
Riyad Preukschas committed
109

110
Create a `git` user for GitLab:
111

112
    sudo adduser --disabled-login --gecos 'GitLab' git
Valery Sizov's avatar
Valery Sizov committed
113

114
## 4. Database
randx's avatar
randx committed
115

116
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.
117 118 119 120 121 122 123 124

    # Install the database packages
    sudo apt-get install -y postgresql-9.1 postgresql-client libpq-dev

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

    # Create a user for GitLab.
125
    template1=# CREATE USER git CREATEDB;
126 127 128 129 130 131 132 133 134

    # 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
randx's avatar
randx committed
135

136
## 5. GitLab
Valery Sizov's avatar
Valery Sizov committed
137

138 139
    # We'll install GitLab into home directory of the user "git"
    cd /home/git
140

141
### Clone the Source
randx's avatar
randx committed
142

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
143
    # Clone GitLab repository
Robert Schilling's avatar
Robert Schilling committed
144
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 7-2-stable gitlab
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
145

Robert Schilling's avatar
Robert Schilling committed
146
**Note:** You can change `7-2-stable` to `master` if you want the *bleeding edge* version, but never install master on a production server!
147

Ben Bodenmiller's avatar
Ben Bodenmiller committed
148
### Configure It
randx's avatar
randx committed
149

150
    # Go to GitLab installation folder
151
    cd /home/git/gitlab
152

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

156 157
    # Make sure to change "localhost" to the fully-qualified domain name of your
    # host serving GitLab where necessary
158
    #
159
    # If you want to use https make sure that you set `https` to `true`. See #using-https for all necessary details.
160
    #
161
    # If you installed Git from source, change the git bin_path to /usr/local/bin/git
162
    sudo -u git -H editor config/gitlab.yml
163

Riyad Preukschas's avatar
Riyad Preukschas committed
164
    # Make sure GitLab can write to the log/ and tmp/ directories
165 166
    sudo chown -R git log/
    sudo chown -R git tmp/
167 168
    sudo chmod -R u+rwX log/
    sudo chmod -R u+rwX tmp/
Riyad Preukschas's avatar
Riyad Preukschas committed
169

170
    # Create directory for satellites
171
    sudo -u git -H mkdir /home/git/gitlab-satellites
Michael  Krane's avatar
Michael Krane committed
172
    sudo chmod u+rwx,g=rx,o-rwx /home/git/gitlab-satellites
173

174 175 176
    # 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/
177

178
    # Make sure GitLab can write to the public/uploads/ directory
179 180
    sudo chmod -R u+rwX  public/uploads

181
    # Copy the example Unicorn config
182
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
183

184 185
    # Enable cluster mode if you expect to have a high load instance
    # Ex. change amount of workers to 3 for 2GB RAM server
Lukas Elmer's avatar
Lukas Elmer committed
186
    sudo -u git -H editor config/unicorn.rb
187

188 189 190
    # Copy the example Rack attack config
    sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb

191 192 193
    # 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"
194
    sudo -u git -H git config --global user.email "example@example.com"
195
    sudo -u git -H git config --global core.autocrlf input
196

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
199
### Configure GitLab DB Settings
200

201
    # PostgreSQL only:
202
    sudo -u git cp config/database.yml.postgresql config/database.yml
203

204 205 206
    # MySQL only:
    sudo -u git cp config/database.yml.mysql config/database.yml

207
    # MySQL and remote PostgreSQL only:
208
    # Update username/password in config/database.yml.
209
    # You only need to adapt the production settings (first part).
210
    # If you followed the database guide then please do as follows:
211 212
    # Change 'secure password' with the value you have given to $password
    # You can keep the double quotes around the password
213
    sudo -u git -H editor config/database.yml
214

215
    # PostgreSQL and MySQL:
216 217
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml
218

219
### Install Gems
220

221
**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.
222

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

226 227 228
    # 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
229
### Install GitLab Shell
230

231
GitLab Shell is an SSH access and repository management software developed specially for GitLab.
232 233

    # Run the installation task for gitlab-shell (replace `REDIS_URL` if needed):
234
    sudo -u git -H bundle exec rake gitlab:shell:install[v1.9.7] REDIS_URL=redis://localhost:6379 RAILS_ENV=production
235

236 237
    # By default, the gitlab-shell config is generated from your main gitlab config.
    #
238
    # Note: When using GitLab with HTTPS please change the following:
239
    # - Provide paths to the certificates under `ca_file` and `ca_path` options.
240 241
    # - The `gitlab_url` option must point to the https endpoint of GitLab.
    # - In case you are using self signed certificate set `self_signed_cert` to `true`.
242
    # See #using-https for all necessary details.
243 244
    #
    # You can review (and modify) the gitlab-shell config as follows:
245
    sudo -u git -H editor /home/git/gitlab-shell/config.yml
246

247
### Initialize Database and Activate Advanced Features
248 249 250 251 252 253 254

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

255
### Install Init Script
256

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

259
    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
260 261 262 263

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
264

Ben Bodenmiller's avatar
Ben Bodenmiller committed
265
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.
266 267 268 269 270

Make GitLab start on boot:

    sudo update-rc.d gitlab defaults 21

271
### Setup Logrotate
272 273

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

275
### Check Application Status
276

277
Check if GitLab and its environment are configured correctly:
278

279
    sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
280

281
### Compile Assets
282 283 284

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

285
### Start Your GitLab Instance
286 287 288 289 290

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

291
## 6. Nginx
Valery Sizov's avatar
Valery Sizov committed
292

293
**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/).
294

295
### Installation
296

297
    sudo apt-get install -y nginx
298

299
### Site Configuration
Riyad Preukschas's avatar
Riyad Preukschas committed
300

301
Copy the example site config:
Riyad Preukschas's avatar
Riyad Preukschas committed
302

303
    sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
304
    sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
Valery Sizov's avatar
Valery Sizov committed
305

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

308 309
    # Change YOUR_SERVER_FQDN to the fully-qualified
    # domain name of your host serving GitLab.
310
    sudo editor /etc/nginx/sites-available/gitlab
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
311

Ben Bodenmiller's avatar
Ben Bodenmiller committed
312 313 314 315 316 317 318 319 320
**Note:** If you want to use HTTPS, replace the `gitlab` Nginx config with `gitlab-ssl`. See [Using HTTPS](#using-https) for all necessary details.

### Test Configuration

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

    sudo nginx -t
    
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 indiciated in the error message given.
321

322
### Restart
Riyad Preukschas's avatar
Riyad Preukschas committed
323

324
    sudo service nginx restart
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
325

326
## Done!
327

328
### Double-check Application Status
329 330 331 332 333 334 335

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!

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

338
### Initial Login
339

340
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
341

342
    root
343
    5iveL!fe
344

345
**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
346 347 348

**Enjoy!**

349
## Advanced Setup Tips
Valery Sizov's avatar
Valery Sizov committed
350

351 352
### Using HTTPS

353
To recapitulate what is needed to use GitLab with HTTPS:
354

355 356 357
1. In `gitlab.yml` set the `https` option to `true`
1. In the `config.yml` of gitlab-shell set the relevant options (see the [install GitLab Shell section](#install-gitlab-shell) of this document).
1. Use the `gitlab-ssl` nginx example config instead of the `gitlab` config.
358

359
### Additional Markup Styles
Valery Sizov's avatar
Valery Sizov committed
360

361
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.
362

363
### Custom Redis Connection
364

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

Riyad Preukschas's avatar
Riyad Preukschas committed
367
    # example
368
    production: redis://redis.example.tld:6379
369

370
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.
371 372 373 374

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

375
### Custom SSH Connection
376

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

379
    # Add to /home/git/.ssh/config
380 381 382 383
    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
384

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

387
### LDAP Authentication
388

389
You can configure LDAP authentication in `config/gitlab.yml`. Please restart GitLab after editing this file.
390

391
### Using Custom Omniauth Providers
392 393 394

GitLab uses [Omniauth](http://www.omniauth.org/) for authentication and already ships with a few providers preinstalled (e.g. LDAP, GitHub, Twitter). But sometimes that is not enough and you need to integrate with other authentication solutions. For these cases you can use the Omniauth provider.

395
#### Steps
396 397 398

These steps are fairly general and you will need to figure out the exact details from the Omniauth provider's documentation.

399 400 401 402 403
-   Stop GitLab:

        sudo service gitlab stop

-   Add the gem to your [Gemfile](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/Gemfile):
404

405
        gem "omniauth-your-auth-provider"
406

407
-   If you're using MySQL, install the new Omniauth provider gem by running the following command:
408

409
        sudo -u git -H bundle install --without development test postgres --path vendor/bundle --no-deployment
410

411
-   If you're using PostgreSQL, install the new Omniauth provider gem by running the following command:
412

413
        sudo -u git -H bundle install --without development test mysql --path vendor/bundle --no-deployment
414

415
    > These are the same commands you used in the [Install Gems section](#install-gems) with `--path vendor/bundle --no-deployment` instead of `--deployment`.
416

417 418
-   Start GitLab:

419
        sudo service gitlab start
420 421

#### Examples
422 423

If you have successfully set up a provider that is not shipped with GitLab itself, please let us know.
424

425
You can help others by reporting successful configurations and probably share a few insights or provide warnings for common errors or pitfalls by sharing your experience [in the public Wiki](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations).
426

427
While we can't officially support every possible authentication mechanism out there, we'd like to at least help those with special needs.