installation.md 16.2 KB
Newer Older
1
# Select Version to Install
2
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
3
this should be the highest numbered stable branch (example shown below).
4

5
![capture](http://i.imgur.com/d2AlIVj.png)
6

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

9
# Important notes
Valeriy's avatar
Valeriy committed
10

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

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

15
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).
16

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

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

21
- - -
Dmytro Zaporozhets (DZ)'s avatar
Dmytro Zaporozhets (DZ) committed
22

Riyad Preukschas's avatar
Riyad Preukschas committed
23
# Overview
Valeriy's avatar
Valeriy committed
24

Paul's avatar
Paul committed
25
The GitLab installation consists of setting up the following components:
26

Riyad Preukschas's avatar
Riyad Preukschas committed
27
1. Packages / Dependencies
28
2. Ruby
Riyad Preukschas's avatar
Riyad Preukschas committed
29
3. System Users
30
31
32
4. Database
5. GitLab
6. Nginx
Valeriy's avatar
Valeriy committed
33
34


Riyad Preukschas's avatar
Riyad Preukschas committed
35
# 1. Packages / Dependencies
Valeriy's avatar
Valeriy committed
36

37
38
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
Robert Speicher's avatar
Robert Speicher committed
39

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

45
**Note:**
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
46
47
48
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.
49

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
50
    # Install vim and set as default editor
51
    sudo apt-get install -y vim
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
52
    sudo update-alternatives --set editor /usr/bin/vim.basic
53

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

56
    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
57

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

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

Jacob Vosmaer's avatar
Jacob Vosmaer committed
63
    # Make sure Git is version 1.7.10 or higher, for example 1.7.12 or 1.8.4
64
65
    git --version

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

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

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

    # Download and compile from source
    cd /tmp
boomshadow's avatar
boomshadow committed
76
77
    curl --progress https://git-core.googlecode.com/files/git-1.8.5.2.tar.gz | tar xz
    cd git-1.8.5.2/
78
79
80
81
82
    make prefix=/usr/local all

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

83
    # When editing config/gitlab.yml (Step 6), change the git bin_path to /usr/local/bin/git
84

85
86
87
88
**Note:** In order to receive mail notifications, make sure to install a
mail server. By default, Debian is shipped with exim4 whereas Ubuntu
does not ship with one. The recommended mail server is postfix and you can install it with:

89
    sudo apt-get install -y postfix
90
91

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

Riyad Preukschas's avatar
Riyad Preukschas committed
93
# 2. Ruby
Valeriy's avatar
Valeriy committed
94

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 stronly 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 --progress ftp://ftp.ruby-lang.org/pub/ruby/2.0/ruby-2.0.0-p481.tar.gz | tar xz
    cd ruby-2.0.0-p481
106
    ./configure --disable-install-rdoc
Valeriy's avatar
Valeriy committed
107
108
109
    make
    sudo make install

110
111
Install the Bundler Gem:

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

Valeriy's avatar
Valeriy committed
114

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

117
Create a `git` user for Gitlab:
118

119
    sudo adduser --disabled-login --gecos 'GitLab' git
Valeriy's avatar
Valeriy committed
120

121
# 4. Database
122

123
We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](database_mysql.md).
124
NOTE: because we need to make use of extensions you need at least pgsql 9.1.
125
126
127
128
129
130
131
132

    # 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.
133
    template1=# CREATE USER git CREATEDB;
134
135
136
137
138
139
140
141
142

    # 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
143
144


145
# 5. GitLab
Valeriy's avatar
Valeriy committed
146

147
148
    # We'll install GitLab into home directory of the user "git"
    cd /home/git
149

Riyad Preukschas's avatar
Riyad Preukschas committed
150
## Clone the Source
151

152
    # Clone GitLab repository
153
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 6-9-stable gitlab
Dmytro Zaporozhets (DZ)'s avatar
Dmytro Zaporozhets (DZ) committed
154

155
    # Go to gitlab dir
156
    cd /home/git/gitlab
157

158
**Note:**
159
You can change `6-9-stable` to `master` if you want the *bleeding edge* version, but never install master on a production server!
160

Riyad Preukschas's avatar
Riyad Preukschas committed
161
## Configure it
162

163
    cd /home/git/gitlab
164

Riyad Preukschas's avatar
Riyad Preukschas committed
165
    # Copy the example GitLab config
166
    sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml
Valeriy's avatar
Valeriy committed
167

168
169
    # Make sure to change "localhost" to the fully-qualified domain name of your
    # host serving GitLab where necessary
170
171
    #
    # If you installed Git from source, change the git bin_path to /usr/local/bin/git
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
172
    sudo -u git -H editor config/gitlab.yml
173

Riyad Preukschas's avatar
Riyad Preukschas committed
174
    # Make sure GitLab can write to the log/ and tmp/ directories
175
176
    sudo chown -R git log/
    sudo chown -R git tmp/
177
178
    sudo chmod -R u+rwX log/
    sudo chmod -R u+rwX tmp/
Riyad Preukschas's avatar
Riyad Preukschas committed
179

180
    # Create directory for satellites
181
    sudo -u git -H mkdir /home/git/gitlab-satellites
182
    sudo chmod u+rwx,g+rx,o-rwx /home/git/gitlab-satellites
183

184
185
186
    # 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/
187

188
    # Make sure GitLab can write to the public/uploads/ directory
189
190
    sudo chmod -R u+rwX  public/uploads

191
    # Copy the example Unicorn config
192
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
Andrew Kumanyaev's avatar
Andrew Kumanyaev committed
193

194
195
    # 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
196
    sudo -u git -H editor config/unicorn.rb
197

Marin Jankovski's avatar
Marin Jankovski committed
198
199
200
    # Copy the example Rack attack config
    sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb

201
202
203
    # 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"
204
    sudo -u git -H git config --global user.email "example@example.com"
205
    sudo -u git -H git config --global core.autocrlf input
206

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

210
211
## Configure GitLab DB settings

212
    # PostgreSQL only:
213
    sudo -u git cp config/database.yml.postgresql config/database.yml
214

215
216
217
    # MySQL only:
    sudo -u git cp config/database.yml.mysql config/database.yml

218
    # MySQL and remote PostgreSQL only:
219
    # Update username/password in config/database.yml.
220
    # You only need to adapt the production settings (first part).
221
    # If you followed the database guide then please do as follows:
222
223
    # Change 'secure password' with the value you have given to $password
    # You can keep the double quotes around the password
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
224
    sudo -u git -H editor config/database.yml
225

226
    # PostgreSQL and MySQL:
227
228
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml
229

Riyad Preukschas's avatar
Riyad Preukschas committed
230
## Install Gems
231

232
233
234
235
236
237
238
**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.

239
    cd /home/git/gitlab
240

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

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

247
248
249
250
251
252
253
254
## Install GitLab shell

GitLab Shell is an ssh access and repository management software developed specially for GitLab.

    # Go to the Gitlab installation folder:
    cd /home/git/gitlab

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

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

260
261
262
263
264
265
266
267
268

## Initialize Database and Activate Advanced Features

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

269
270
271
272
## Install Init Script

Download the init script (will be /etc/init.d/gitlab):

273
    sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
Rovanion Luckey's avatar
Rovanion Luckey committed
274
275
276
277

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
278
279

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.
280
281
282
283
284

Make GitLab start on boot:

    sudo update-rc.d gitlab defaults 21

285
286
287
## Set up logrotate

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

Riyad Preukschas's avatar
Riyad Preukschas committed
289
## Check Application Status
Robert Speicher's avatar
Robert Speicher committed
290

291
Check if GitLab and its environment are configured correctly:
292

293
    sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
294

295
296
297
298
## Compile assets

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

299
300
301
302
303
304
## Start Your GitLab Instance

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

Valeriy's avatar
Valeriy committed
305

306
# 6. Nginx
307

308
**Note:**
309
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
dosire's avatar
dosire committed
310
[GitLab recipes](https://gitlab.com/gitlab-org/gitlab-recipes/).
311

Riyad Preukschas's avatar
Riyad Preukschas committed
312
## Installation
313
    sudo apt-get install -y nginx
314

Riyad Preukschas's avatar
Riyad Preukschas committed
315
316
317
318
## Site Configuration

Download an example site config:

319
    sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab
320
    sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
Valeriy's avatar
Valeriy committed
321

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

324
325
    # Change YOUR_SERVER_FQDN to the fully-qualified
    # domain name of your host serving GitLab.
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
326
    sudo editor /etc/nginx/sites-available/gitlab
Dmytro Zaporozhets (DZ)'s avatar
Dmytro Zaporozhets (DZ) committed
327

Riyad Preukschas's avatar
Riyad Preukschas committed
328
329
## Restart

330
    sudo service nginx restart
Dmytro Zaporozhets (DZ)'s avatar
Dmytro Zaporozhets (DZ) committed
331

332

Riyad Preukschas's avatar
Riyad Preukschas committed
333
# Done!
334

335
336
337
338
339
340
341
342
343
344
345
## Double-check Application Status

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!

## Initial Login

Visit YOUR_SERVER in your web browser for your first GitLab login.
Riyad Preukschas's avatar
Riyad Preukschas committed
346
The setup has created an admin account for you. You can use it to log in:
Valeriy's avatar
Valeriy committed
347

348
    root
349
    5iveL!fe
350

351
**Important Note:**
352
Please go over to your profile page and immediately change the password, so
Riyad Preukschas's avatar
Riyad Preukschas committed
353
354
355
356
nobody can access your GitLab by using this login information later on.

**Enjoy!**

Valeriy's avatar
Valeriy committed
357

358
359
- - -

Valeriy's avatar
Valeriy committed
360

361
# Advanced Setup Tips
362

363
364
365
## Additional markup styles

Apart from the always supported markdown style there are other rich text files that GitLab can display.
Evgeniy Sokovikov's avatar
Evgeniy Sokovikov committed
366
But you might have to install a dependency to do so.
367
368
369
370
371
Please see the [github-markup gem readme](https://github.com/gitlabhq/markup#markups) for more information.
For example, reStructuredText markup language support requires python-docutils:

    sudo apt-get install -y python-docutils

372
## Custom Redis Connection
373
374

If you'd like Resque to connect to a Redis server on a non-standard port or on
Riyad Preukschas's avatar
Riyad Preukschas committed
375
376
a different host, you can configure its connection string via the
`config/resque.yml` file.
377

Riyad Preukschas's avatar
Riyad Preukschas committed
378
    # example
379
    production: redis://redis.example.tld:6379
380

381
If you want to connect the Redis server via socket, then use the "unix:" URL scheme
382
383
384
385
386
and the path to the Redis socket file in the `config/resque.yml` file.

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

387
388
## Custom SSH Connection

389
If you are running SSH on a non-standard port, you must change the gitlab user's SSH config.
390

391
    # Add to /home/git/.ssh/config
392
393
394
395
    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
396

397
You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the `config\gitlab.yml` file.
398
399
400
401
402
403
404
405
406
407
408
409
410

## LDAP authentication

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

## Using Custom Omniauth Providers

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.

### Steps

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

411
* Stop GitLab
412
    `sudo service gitlab stop`
413

Marcio Toze's avatar
Marcio Toze committed
414
* Add provider specific configuration options to your `config/gitlab.yml` (you can use the [auth providers section of the example config](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example) as a reference)
415

Marcio Toze's avatar
Marcio Toze committed
416
* Add the gem to your [Gemfile](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/Gemfile)
417
                `gem "omniauth-your-auth-provider"`
418
* If you're using MySQL, install the new Omniauth provider gem by running the following command:
419
    `sudo -u git -H bundle install --without development test postgres --path vendor/bundle --no-deployment`
420
421

* If you're using PostgreSQL, install the new Omniauth provider gem by running the following command:
422
    `sudo -u git -H bundle install --without development test mysql --path vendor/bundle --no-deployment`
423
424
425
426

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

* Start GitLab
427
    `sudo service gitlab start`
428

429
430
431
432

### Examples

If you have successfully set up a provider that is not shipped with GitLab itself, please let us know.
433
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).
434
While we can't officially support every possible auth mechanism out there, we'd like to at least help those with special needs.