Skip to content
Snippets Groups Projects
Select Git revision
  • move-gl-dropdown
  • improve-table-pagination-spec
  • move-markdown-preview
  • winh-fix-merge-request-spec
  • master default
  • index-namespaces-lower-name
  • winh-single-karma-test
  • 10-3-stable
  • 36782-replace-team-user-role-with-add_role-user-in-specs
  • winh-modal-internal-state
  • tz-ide-file-icons
  • 38869-milestone-select
  • update-autodevops-template
  • jivl-activate-repo-cookie-preferences
  • qa-add-deploy-key
  • docs-move-article-ldap
  • 40780-choose-file
  • 22643-manual-job-page
  • refactor-cluster-show-page-conservative
  • dm-sidekiq-versioning
  • v10.4.0.pre
  • v10.3.0
  • v10.3.0-rc5
  • v10.3.0-rc4
  • v10.3.0-rc3
  • v10.3.0-rc2
  • v10.2.5
  • v10.3.0-rc1
  • v10.0.7
  • v10.1.5
  • v10.2.4
  • v10.2.3
  • v10.2.2
  • v10.2.1
  • v10.3.0.pre
  • v10.2.0
  • v10.2.0-rc4
  • v10.2.0-rc3
  • v10.1.4
  • v10.2.0-rc2
40 results

installation.md

Blame
  • Forked from GitLab.org / GitLab FOSS
    15840 commits behind the upstream repository.
    installation.md 24.68 KiB

    Installation from source

    Consider the Omnibus package installation

    Since an installation from source is a lot of work and error prone we strongly recommend the fast and reliable Omnibus package installation (deb/rpm).

    One reason the Omnibus package is more reliable is its use of Runit to restart any of the GitLab processes in case one crashes. On heavily used GitLab instances the memory usage of the Sidekiq background worker will grow over time. Omnibus packages solve this by letting the Sidekiq terminate gracefully if it uses too much memory. After this termination Runit will detect Sidekiq is not running and will start it. Since installations from source don't have Runit, Sidekiq can't be terminated and its memory usage will grow over time.

    Select Version to Install

    Make sure you view this installation guide from the tag (version) of GitLab you would like to install. 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).

    If the highest number stable branch is unclear please check the GitLab Blog for installation guide links by version.

    Important Notes

    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.

    This installation guide was created for and tested on Debian/Ubuntu operating systems. Please read requirements.md for hardware and operating system requirements. If you want to install on RHEL/CentOS we recommend using the Omnibus packages.

    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.

    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.

    If you find a bug/error in this guide please submit a merge request following the contributing guide.

    Overview

    The GitLab installation consists of setting up the following components:

    1. Packages / Dependencies
    2. Ruby
    3. Go
    4. System Users
    5. Database
    6. Redis
    7. GitLab
    8. Nginx

    1. Packages / Dependencies

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

    # run as root!
    apt-get update -y
    apt-get upgrade -y
    apt-get install sudo -y

    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.

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

    Install the required packages (needed to compile Ruby and native extensions to Ruby gems):

    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

    If you want to use Kerberos for user authentication, then install libkrb5-dev:

    sudo apt-get install libkrb5-dev

    Note: If you don't know what Kerberos is, you can assume you don't need it.

    Make sure you have the right version of Git installed

    # Install Git
    sudo apt-get install -y git-core
    
    # Make sure Git is version 2.7.4 or higher
    git --version

    Is the system packaged Git too old? Remove it and compile from source.

    # Remove packaged Git
    sudo apt-get remove git-core
    
    # Install dependencies
    sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential
    
    # Download and compile from source
    cd /tmp
    curl --remote-name --progress https://www.kernel.org/pub/software/scm/git/git-2.7.4.tar.gz
    echo '7104c4f5d948a75b499a954524cb281fe30c6649d8abe20982936f75ec1f275b  git-2.7.4.tar.gz' | shasum -a256 -c - && tar -xzf git-2.7.4.tar.gz
    cd git-2.7.4/
    ./configure
    make prefix=/usr/local all
    
    # Install into /usr/local/bin
    sudo make prefix=/usr/local install
    
    # When editing config/gitlab.yml (Step 5), change the git -> bin_path to /usr/local/bin/git

    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 while Ubuntu does not ship with one. The recommended mail server is postfix and you can install it with:

    sudo apt-get install -y postfix

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

    2. Ruby

    _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.

    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:

    sudo apt-get remove ruby1.8

    Download Ruby and compile it:

    mkdir /tmp/ruby && cd /tmp/ruby
    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
    ./configure --disable-install-rdoc
    make
    sudo make install

    Install the Bundler Gem:

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

    3. Go

    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 page.

    curl --remote-name --progress https://storage.googleapis.com/golang/go1.5.3.linux-amd64.tar.gz
    echo '43afe0c5017e502630b1aea4d44b8a7f059bf60d7f29dfd58db454d4e4e0ae53  go1.5.3.linux-amd64.tar.gz' | shasum -a256 -c - && \
      sudo tar -C /usr/local -xzf go1.5.3.linux-amd64.tar.gz
    sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/
    rm go1.5.3.linux-amd64.tar.gz

    4. System Users

    Create a git user for GitLab:

    sudo adduser --disabled-login --gecos 'GitLab' git

    5. Database

    We recommend using a PostgreSQL database. For MySQL check the MySQL setup guide.

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

    1. Install the database packages:

      sudo apt-get install -y postgresql postgresql-client libpq-dev postgresql-contrib
    2. Create a database user for GitLab:

      sudo -u postgres psql -d template1 -c "CREATE USER git CREATEDB;"
    3. Create the GitLab production database and grant all privileges on database:

      sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;"
    4. Create the pg_trgm extension (required for GitLab 8.6+):

      sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;"
    5. Try connecting to the new database with the new user:

      sudo -u git -H psql -d gitlabhq_production
    6. Check if the pg_trgm extension is enabled:

      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)
    7. Quit the database session:

      gitlabhq_production> \q

    6. Redis

    GitLab requires at least Redis 2.8.

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

    sudo apt-get install redis-server

    If you are using Debian 7 or Ubuntu 12.04, follow the special documentation on an alternate Redis installation. Once done, follow the rest of the guide here.

    # Configure redis to use sockets
    sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig
    
    # 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
    
    # 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
    
    # Activate the changes to redis.conf
    sudo service redis-server restart
    
    # Add git to the redis group
    sudo usermod -aG redis git

    7. GitLab

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

    Clone the Source

    # Clone GitLab repository
    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 8-12-stable gitlab

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

    Configure It

    # Go to GitLab installation folder
    cd /home/git/gitlab
    
    # Copy the example GitLab config
    sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml
    
    # Update GitLab config file, follow the directions at top of file
    sudo -u git -H editor config/gitlab.yml
    
    # 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
    
    # Make sure GitLab can write to the log/ and tmp/ directories
    sudo chown -R git log/
    sudo chown -R git tmp/
    sudo chmod -R u+rwX,go-w log/
    sudo chmod -R u+rwX tmp/
    
    # 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/
    
    # Create the public/uploads/ directory
    sudo -u git -H mkdir public/uploads/
    
    # Make sure only the GitLab user has access to the public/uploads/ directory
    # now that files in public/uploads are served by gitlab-workhorse
    sudo chmod 0700 public/uploads
    
    # Change the permissions of the directory where CI build traces are stored
    sudo chmod -R u+rwX builds/
    
    # Change the permissions of the directory where CI artifacts are stored
    sudo chmod -R u+rwX shared/artifacts/
    
    # Copy the example Unicorn config
    sudo -u git -H cp config/unicorn.rb.example config/unicorn.rb
    
    # Find number of cores
    nproc
    
    # Enable cluster mode if you expect to have a high load instance
    # Set the number of workers to at least the number of cores
    # Ex. change amount of workers to 3 for 2GB RAM server
    sudo -u git -H editor config/unicorn.rb
    
    # Copy the example Rack attack config
    sudo -u git -H cp config/initializers/rack_attack.rb.example config/initializers/rack_attack.rb
    
    # Configure Git global settings for git user
    # 'autocrlf' is needed for the web editor
    sudo -u git -H git config --global core.autocrlf input
    
    # Disable 'git gc --auto' because GitLab already runs 'git gc' when needed
    sudo -u git -H git config --global gc.auto 0
    
    # Enable packfile bitmaps
    sudo -u git -H git config --global repack.writeBitmaps true
    
    # Configure Redis connection settings
    sudo -u git -H cp config/resque.yml.example config/resque.yml
    
    # Change the Redis socket path if you are not using the default Debian / Ubuntu configuration
    sudo -u git -H editor config/resque.yml

    Important Note: Make sure to edit both gitlab.yml and unicorn.rb to match your setup.

    Note: If you want to use HTTPS, see Using HTTPS for the additional steps.

    Configure GitLab DB Settings

    # PostgreSQL only:
    sudo -u git cp config/database.yml.postgresql config/database.yml
    
    # MySQL only:
    sudo -u git cp config/database.yml.mysql config/database.yml
    
    # MySQL and remote PostgreSQL only:
    # Update username/password in config/database.yml.
    # You only need to adapt the production settings (first part).
    # If you followed the database guide then please do as follows:
    # Change 'secure password' with the value you have given to $password
    # You can keep the double quotes around the password
    sudo -u git -H editor config/database.yml
    
    # PostgreSQL and MySQL:
    # Make config/database.yml readable to git only
    sudo -u git -H chmod o-rwx config/database.yml

    Install Gems

    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. First make sure you have bundler >= 1.5.2 (run bundle -v) as it addresses some issues that were fixed in 1.5.2.

    # For PostgreSQL (note, the option says "without ... mysql")
    sudo -u git -H bundle install --deployment --without development test mysql aws kerberos
    
    # Or if you use MySQL (note, the option says "without ... postgres")
    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.

    Install GitLab Shell

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

    # Run the installation task for gitlab-shell (replace `REDIS_URL` if needed):
    sudo -u git -H bundle exec rake gitlab:shell:install REDIS_URL=unix:/var/run/redis/redis.sock RAILS_ENV=production
    
    # By default, the gitlab-shell config is generated from your main GitLab config.
    # You can review (and modify) the gitlab-shell config as follows:
    sudo -u git -H editor /home/git/gitlab-shell/config.yml

    Note: If you want to use HTTPS, see Using HTTPS for the additional steps.

    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)".

    Install gitlab-workhorse

    GitLab-Workhorse uses GNU Make. If you are not using Linux you may have to run gmake instead of make below.