gitlabhq/doc/install/installation.md

372 lines
10 KiB
Markdown
Raw Normal View History

This installation guide was created for Debian/Ubuntu and tested on it.
Please read `doc/install/requirements.md` for hardware and platform requirements.
2012-03-12 13:47:57 +01:00
2012-03-13 19:19:03 +01:00
**Important Note:**
2012-12-05 20:34:11 +01:00
The following steps have been known to work.
If you deviate from this guide, do it with caution and make sure you don't
violate any assumptions GitLab makes about its environment.
For things like AWS installation scripts, init scripts or config files for
alternative web server have a look at the "Advanced Setup Tips" section.
**Important Note:**
If you find a bug/error in this guide please submit an issue or pull request
following the contribution guide (see `CONTRIBUTING.md`).
2012-10-10 16:17:23 +02:00
2012-10-25 10:13:11 +02:00
- - -
2012-03-13 19:19:03 +01:00
2012-12-05 20:34:11 +01:00
# Overview
2012-03-12 13:47:57 +01:00
The GitLab installation consists of setting up the following components:
2012-12-05 20:34:11 +01:00
1. Packages / Dependencies
2012-10-24 19:59:48 +02:00
2. Ruby
2012-12-05 20:34:11 +01:00
3. System Users
2012-10-24 19:59:48 +02:00
4. Gitolite
2012-12-05 20:34:11 +01:00
5. Database
6. GitLab
7. Nginx
2012-03-12 13:47:57 +01:00
2012-12-05 20:34:11 +01:00
# 1. Packages / Dependencies
2012-03-12 13:47:57 +01:00
`sudo` is not installed on Debian by default. If you don't have it you'll need
to install it first.
# run as root
apt-get update && apt-get upgrade && apt-get install sudo
2012-12-05 20:34:11 +01:00
Make sure your system is up-to-date:
2012-03-12 13:47:57 +01:00
sudo apt-get update
sudo apt-get upgrade
**Note:**
Vim is an editor that is used here whenever there are files that need to be
edited by hand. But, you can use any editor you like instead.
# Install vim
sudo apt-get install -y vim
2012-12-05 20:34:11 +01:00
Install the required packages:
2012-12-28 13:38:43 +01:00
sudo apt-get install -y build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libreadline-dev libncurses5-dev libffi-dev curl git-core openssh-server redis-server postfix checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libicu-dev
Make sure you have the right version of Python installed.
# Install Python
sudo apt-get install python
2012-12-12 22:36:20 +01:00
# Make sure that Python is 2.5+ (3.x is not supported at the moment)
python --version
# If it's Python 3 you might need to install Python 2 separately
sudo apt-get install python2.7
# Make sure you can access Python via python2
python2 --version
# If you get a "command not found" error create a link to the python binary
sudo ln -s /usr/bin/python /usr/bin/python2
2012-12-05 20:34:11 +01:00
# 2. Ruby
2012-03-12 13:47:57 +01:00
Download and compile it:
mkdir /tmp/ruby && cd /tmp/ruby
2012-12-28 13:38:43 +01:00
curl --progress http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p327.tar.gz | tar xz
2012-12-05 20:34:11 +01:00
cd ruby-1.9.3-p327
2012-03-12 13:47:57 +01:00
./configure
make
sudo make install
Install the Bundler Gem:
sudo gem install bundler
2012-03-12 13:47:57 +01:00
2012-12-05 20:34:11 +01:00
# 3. System Users
Create a user for Git and Gitolite:
2012-03-12 13:47:57 +01:00
sudo adduser \
--system \
--shell /bin/sh \
2012-12-05 20:34:11 +01:00
--gecos 'Git Version Control' \
2012-03-12 13:47:57 +01:00
--group \
--disabled-password \
--home /home/git \
git
2012-12-05 20:34:11 +01:00
Create a user for GitLab:
2012-03-12 13:47:57 +01:00
2012-12-05 20:34:11 +01:00
sudo adduser --disabled-login --gecos 'GitLab' gitlab
2012-12-05 20:34:11 +01:00
# Add it to the git group
2012-12-09 15:05:24 +01:00
sudo usermod -a -G git gitlab
2012-12-05 20:34:11 +01:00
# Generate the SSH key
2012-12-05 18:21:28 +01:00
sudo -u gitlab -H ssh-keygen -q -N '' -t rsa -f /home/gitlab/.ssh/id_rsa
2012-03-12 13:47:57 +01:00
2012-10-24 19:59:48 +02:00
# 4. Gitolite
Clone GitLab's fork of the Gitolite source code:
cd /home/git
2012-12-17 14:11:33 +01:00
sudo -u git -H git clone -b gl-v320 https://github.com/gitlabhq/gitolite.git /home/git/gitolite
2012-03-12 13:47:57 +01:00
2012-12-05 20:34:11 +01:00
Setup Gitolite with GitLab as its admin:
**Important Note:**
2012-12-05 20:34:11 +01:00
GitLab assumes *full and unshared* control over this Gitolite installation.
2012-12-05 20:34:11 +01:00
# Add Gitolite scripts to $PATH
sudo -u git -H mkdir /home/git/bin
sudo -u git -H sh -c 'printf "%b\n%b\n" "PATH=\$PATH:/home/git/bin" "export PATH" >> /home/git/.profile'
2012-12-05 18:21:28 +01:00
sudo -u git -H sh -c 'gitolite/install -ln /home/git/bin'
2012-08-29 01:03:04 +02:00
2012-12-05 20:34:11 +01:00
# Copy the gitlab user's (public) SSH key ...
2012-03-12 13:47:57 +01:00
sudo cp /home/gitlab/.ssh/id_rsa.pub /home/git/gitlab.pub
sudo chmod 0444 /home/git/gitlab.pub
2012-03-12 13:47:57 +01:00
# ... and use it as the admin key for the Gitolite setup
2012-08-29 01:03:04 +02:00
sudo -u git -H sh -c "PATH=/home/git/bin:$PATH; gitolite setup -pk /home/git/gitlab.pub"
Fix the directory permissions for the configuration directory:
# Make sure the Gitolite config dir is owned by git
sudo chmod 750 /home/git/.gitolite/
sudo chown -R git:git /home/git/.gitolite/
2012-12-12 22:36:20 +01:00
Fix the directory permissions for the repositories:
2012-12-05 20:34:11 +01:00
# Make sure the repositories dir is owned by git and it stays that way
sudo chmod -R ug+rwX,o-rwx /home/git/repositories/
2012-03-12 13:47:57 +01:00
sudo chown -R git:git /home/git/repositories/
find /home/git/repositories -type d -print0 | sudo xargs -0 chmod g+s
2012-03-12 13:47:57 +01:00
2012-12-22 23:35:52 +01:00
2013-01-17 10:57:47 +01:00
## Add domains to list to the list of known hosts
2012-12-22 23:35:52 +01:00
2013-01-17 10:57:47 +01:00
sudo -u gitlab -H ssh git@localhost
sudo -u gitlab -H ssh git@YOUR_DOMAIN_NAME
sudo -u gitlab -H ssh git@YOUR_GITOLITE_DOMAIN_NAME
2012-12-22 23:35:52 +01:00
2012-12-05 20:34:11 +01:00
## Test if everything works so far
# Clone the admin repo so SSH adds localhost to known_hosts ...
# ... and to be sure your users have access to Gitolite
sudo -u gitlab -H git clone git@localhost:gitolite-admin.git /tmp/gitolite-admin
2012-03-12 13:47:57 +01:00
2012-12-05 20:34:11 +01:00
# If it succeeded without errors you can remove the cloned repo
sudo rm -rf /tmp/gitolite-admin
2012-03-12 13:47:57 +01:00
**Important Note:**
If you can't clone the `gitolite-admin` repository: **DO NOT PROCEED WITH INSTALLATION**!
Check the [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
2012-12-05 20:34:11 +01:00
and make sure you have followed all of the above steps carefully.
2012-03-12 13:47:57 +01:00
# 5. Database
2012-10-24 19:42:55 +02:00
See `doc/install/databases.md`
2012-10-24 19:42:55 +02:00
2012-10-24 19:59:48 +02:00
# 6. GitLab
2012-03-12 13:47:57 +01:00
# We'll install GitLab into home directory of the user "gitlab"
2012-03-12 13:47:57 +01:00
cd /home/gitlab
2012-12-05 20:34:11 +01:00
## Clone the Source
2012-10-24 19:59:48 +02:00
2012-12-23 12:57:40 +01:00
# Clone GitLab repository
sudo -u gitlab -H git clone https://github.com/gitlabhq/gitlabhq.git gitlab
2012-12-23 12:58:41 +01:00
# Go to gitlab dir
cd /home/gitlab/gitlab
2012-12-23 12:57:40 +01:00
# Checkout to stable release
2013-01-21 15:36:55 +01:00
sudo -u gitlab -H git checkout 4-1-stable
**Note:**
2013-01-21 15:36:55 +01:00
You can change `4-1-stable` to `master` if you want the *bleeding edge* version, but
2012-12-05 20:34:11 +01:00
do so with caution!
2012-12-05 20:34:11 +01:00
## Configure it
2012-10-24 19:59:48 +02:00
2012-12-05 20:34:11 +01:00
cd /home/gitlab/gitlab
2012-12-05 20:34:11 +01:00
# Copy the example GitLab config
2012-12-05 18:21:28 +01:00
sudo -u gitlab -H cp config/gitlab.yml.example config/gitlab.yml
2012-03-12 13:47:57 +01:00
2012-12-07 17:28:05 +01:00
# Make sure to change "localhost" to the fully-qualified domain name of your
# host serving GitLab where necessary
sudo -u gitlab -H vim config/gitlab.yml
2012-12-12 22:36:20 +01:00
# Make sure GitLab can write to the log/ and tmp/ directories
sudo chown -R gitlab log/
sudo chown -R gitlab tmp/
sudo chmod -R u+rwX log/
sudo chmod -R u+rwX tmp/
# Make directory for satellites
sudo -u gitlab -H mkdir /home/gitlab/gitlab-satellites
2012-12-05 20:34:11 +01:00
# Copy the example Unicorn config
2012-12-05 18:21:28 +01:00
sudo -u gitlab -H cp config/unicorn.rb.example config/unicorn.rb
2012-10-10 01:41:33 +02:00
**Important Note:**
2012-12-05 20:34:11 +01:00
Make sure to edit both files to match your setup.
## Configure GitLab DB settings
# Mysql
sudo -u gitlab cp config/database.yml.mysql config/database.yml
# PostgreSQL
sudo -u gitlab cp config/database.yml.postgresql config/database.yml
Make sure to update username/password in config/database.yml.
2012-12-05 20:34:11 +01:00
## Install Gems
2012-10-24 19:59:48 +02:00
cd /home/gitlab/gitlab
sudo gem install charlock_holmes --version '0.6.9'
# For MySQL (note, the option says "without")
sudo -u gitlab -H bundle install --deployment --without development test postgres
# Or for PostgreSQL
sudo -u gitlab -H bundle install --deployment --without development test mysql
2012-03-12 13:47:57 +01:00
2012-12-05 20:34:11 +01:00
## Configure Git
2012-12-05 20:34:11 +01:00
GitLab needs to be able to commit and push changes to Gitolite. In order to do
that Git requires a username and email. (We recommend using the same address
used for the `email.from` setting in `config/gitlab.yml`)
2012-12-05 20:34:11 +01:00
sudo -u gitlab -H git config --global user.name "GitLab"
sudo -u gitlab -H git config --global user.email "gitlab@localhost"
2012-12-12 22:36:20 +01:00
## Setup GitLab Hooks
2012-12-05 20:34:11 +01:00
sudo cp ./lib/hooks/post-receive /home/git/.gitolite/hooks/common/post-receive
sudo chown git:git /home/git/.gitolite/hooks/common/post-receive
2012-12-05 20:34:11 +01:00
## Initialise Database and Activate Advanced Features
2012-10-24 19:50:34 +02:00
sudo -u gitlab -H bundle exec rake gitlab:setup RAILS_ENV=production
## Install Init Script
Download the init script (will be /etc/init.d/gitlab):
2012-12-28 13:38:43 +01:00
sudo curl --output /etc/init.d/gitlab https://raw.github.com/gitlabhq/gitlab-recipes/master/init.d/gitlab
sudo chmod +x /etc/init.d/gitlab
Make GitLab start on boot:
sudo update-rc.d gitlab defaults 21
2012-12-05 20:34:11 +01:00
## Check Application Status
Check if GitLab and its environment is configured correctly:
sudo -u gitlab -H bundle exec rake gitlab:env:info RAILS_ENV=production
To make sure you didn't miss anything run a more thorough check with:
2012-12-12 22:36:20 +01:00
sudo -u gitlab -H bundle exec rake gitlab:check RAILS_ENV=production
2012-03-12 13:47:57 +01:00
If all items are green, then congratulations on successfully installing GitLab!
However there are still a few steps left.
2012-03-12 13:47:57 +01:00
## Start Your GitLab Instance
2012-03-12 13:47:57 +01:00
2012-10-24 19:50:34 +02:00
sudo service gitlab start
2012-12-12 22:36:20 +01:00
# or
sudo /etc/init.d/gitlab restart
2012-03-12 13:47:57 +01:00
2012-10-24 19:50:34 +02:00
# 7. Nginx
**Note:**
If you can't or don't want to use Nginx as your web server, have a look at the
"Advanced Setup Tips" section.
2012-12-05 20:34:11 +01:00
## Installation
sudo apt-get install nginx
2012-12-05 20:34:11 +01:00
## Site Configuration
Download an example site config:
2012-12-28 13:38:43 +01:00
sudo curl --output /etc/nginx/sites-available/gitlab https://raw.github.com/gitlabhq/gitlab-recipes/master/nginx/gitlab
sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
2012-03-12 13:47:57 +01:00
2012-12-05 20:34:11 +01:00
Make sure to edit the config file to match your setup:
# Change **YOUR_SERVER_IP** and **YOUR_SERVER_FQDN**
# to the IP address and fully-qualified domain name
2012-12-05 20:34:11 +01:00
# of your host serving GitLab
sudo vim /etc/nginx/sites-enabled/gitlab
2012-03-13 19:19:03 +01:00
2012-12-05 20:34:11 +01:00
## Restart
sudo /etc/init.d/nginx restart
2012-03-13 19:19:03 +01:00
2012-12-05 20:34:11 +01:00
# Done!
2012-12-05 20:34:11 +01:00
Visit YOUR_SERVER for your first GitLab login.
The setup has created an admin account for you. You can use it to log in:
2012-03-12 13:51:21 +01:00
admin@local.host
5iveL!fe
**Important Note:**
2012-12-05 20:34:11 +01:00
Please go over to your profile page and immediately chage the password, so
nobody can access your GitLab by using this login information later on.
**Enjoy!**
2012-03-12 13:47:57 +01:00
2012-10-25 10:13:11 +02:00
- - -
2012-03-12 13:47:57 +01:00
# Advanced Setup Tips
2012-10-24 19:42:55 +02:00
## Custom Redis Connection
If you'd like Resque to connect to a Redis server on a non-standard port or on
2012-12-05 20:34:11 +01:00
a different host, you can configure its connection string via the
`config/resque.yml` file.
2012-12-05 20:34:11 +01:00
# example
production: redis.example.tld:6379
## Custom SSH Connection
If you are running SSH on a non-standard port, you must change the gitlab user'S SSH config.
# Add to /home/gitlab/.ssh/config
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
You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the `config\gitlab.yml` file.
## User-contributed Configurations
You can find things like AWS installation scripts, init scripts or config files
for alternative web server in our [recipes collection](https://github.com/gitlabhq/gitlab-recipes/).