deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update installation guide

Browse source
This commit is contained in:
Riyad Preukschas 2012-12-05 20:34:11 +01:00
parent 198e93ccf2
commit 4af26f66f8
1 changed files with 121 additions and 109 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

202
doc/install/installation.md
View file

@ -3,87 +3,75 @@ This installation guide was created for Debian/Ubuntu and tested on it.
Please read doc/install/requirements.md for hardware andplatform requirements. Please read doc/install/requirements.md for hardware andplatform requirements.
**Important Note**
### IMPORTANT The following steps have been known to work.
If you deviate from this guide, do it with caution and make sure you don't
Please make sure you have followed all the steps below before posting to the mailing list with installation and configuration questions. violate any assumptions GitLab makes about its environment.
If you find a bug/error in this guide please an issue or pull request following
Only create a GitHub Issue if you want a specific part of this installation guide updated. the contribution guide (see CONTRIBUTING.md).
Also read the [Read this before you submit an issue](https://github.com/gitlabhq/gitlabhq/wiki/Read-this-before-you-submit-an-issue) wiki page.
- - - - - -
# Basic setup # Overview
The basic installation will provide you a GitLab setup with options: The GitLab installation consists of setting up th following components:
1. ruby 1.9.3 1. Packages / Dependencies
2. mysql as main db
3. gitolite v3 fork by gitlab
4. nginx + unicorn
The installation consists of next steps:
1. Packages / dependencies
2. Ruby 2. Ruby
3. Users 3. System Users
4. Gitolite 4. Gitolite
5. Mysql 5. Database
6. GitLab. 6. GitLab
7. Nginx 7. Nginx
# 1. Packages / dependencies # 1. Packages / Dependencies
*Keep in mind that `sudo` is not installed on Debian by default. You should install it as root:* *Keep in mind that `sudo` is not installed on Debian by default. You should install it as root:*
apt-get update && apt-get upgrade && apt-get install sudo apt-get update && apt-get upgrade && apt-get install sudo
Now install the required packages: Make sure your system is up-to-date:
sudo apt-get update sudo apt-get update
sudo apt-get upgrade sudo apt-get upgrade
Install the required packages:
sudo apt-get install -y wget curl build-essential checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libreadline6-dev libc6-dev libssl-dev zlib1g-dev libicu-dev redis-server openssh-server git-core python2.7 libyaml-dev postfix sudo apt-get install -y wget curl build-essential checkinstall libxml2-dev libxslt-dev libcurl4-openssl-dev libreadline6-dev libc6-dev libssl-dev zlib1g-dev libicu-dev redis-server openssh-server git-core python2.7 libyaml-dev postfix
sudo pip install pygments
# 2. Ruby
# 2. Install Ruby wget http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p327.tar.gz
tar xfvz ruby-1.9.3-p327.tar.gz
wget http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p194.tar.gz cd ruby-1.9.3-p327
tar xfvz ruby-1.9.3-p194.tar.gz
cd ruby-1.9.3-p194
./configure ./configure
make make
sudo make install sudo make install
# 3. Users
Create user for git: # 3. System Users
Create a user for Git and Gitolite:
sudo adduser \ sudo adduser \
--system \ --system \
--shell /bin/sh \ --shell /bin/sh \
--gecos 'git version control' \ --gecos 'Git Version Control' \
--group \ --group \
--disabled-password \ --disabled-password \
--home /home/git \ --home /home/git \
git git
Create user for GitLab: Create a user for GitLab:
# ubuntu/debian sudo adduser --disabled-login --gecos 'GitLab' gitlab
sudo adduser --disabled-login --gecos 'gitlab system' gitlab
Add your users to groups: # Add it to the git group
sudo addmod -a -G git gitlab
sudo usermod -a -G git gitlab
sudo usermod -a -G gitlab git
Generate key:
# Generate the SSH key
sudo -u gitlab -H ssh-keygen -q -N '' -t rsa -f /home/gitlab/.ssh/id_rsa sudo -u gitlab -H ssh-keygen -q -N '' -t rsa -f /home/gitlab/.ssh/id_rsa
@ -93,34 +81,43 @@ Clone GitLab's fork of the Gitolite source code:
sudo -u git -H git clone -b gl-v304 https://github.com/gitlabhq/gitolite.git /home/git/gitolite sudo -u git -H git clone -b gl-v304 https://github.com/gitlabhq/gitolite.git /home/git/gitolite
Setup: Setup Gitolite with GitLab as its admin:
**Important Note**
GitLab assumes *full and unshared* control over this Gitolite installation.
# Add Gitolite scripts to $PATH
cd /home/git cd /home/git
sudo -u git -H mkdir bin sudo -u git -H mkdir bin
sudo -u git -H sh -c 'echo -e "PATH=\$PATH:/home/git/bin\nexport PATH" >> /home/git/.profile' sudo -u git -H sh -c 'echo -e "PATH=\$PATH:/home/git/bin\nexport PATH" >> /home/git/.profile'
sudo -u git -H sh -c 'gitolite/install -ln /home/git/bin' sudo -u git -H sh -c 'gitolite/install -ln /home/git/bin'
# Copy the gitlab user's (public) SSH key ...
sudo cp /home/gitlab/.ssh/id_rsa.pub /home/git/gitlab.pub sudo cp /home/gitlab/.ssh/id_rsa.pub /home/git/gitlab.pub
sudo chmod 0444 /home/git/gitlab.pub sudo chmod 0444 /home/git/gitlab.pub
# ... and use it as the Gitolite admin key for setup
sudo -u git -H sh -c "PATH=/home/git/bin:$PATH; gitolite setup -pk /home/git/gitlab.pub" sudo -u git -H sh -c "PATH=/home/git/bin:$PATH; gitolite setup -pk /home/git/gitlab.pub"
Fix the directory permissions for the repository:
Permissions: # Make sure the repositories dir is owned by git and it stays that way
sudo chmod -R ug+rwXs /home/git/repositories/ sudo chmod -R ug+rwXs /home/git/repositories/
sudo chown -R git:git /home/git/repositories/ sudo chown -R git:git /home/git/repositories/
# clone admin repo to add localhost to known_hosts ## Test if everything works so far
# & be sure your user has access to gitolite
# 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 sudo -u gitlab -H git clone git@localhost:gitolite-admin.git /tmp/gitolite-admin
# if succeed you can remove it # If it succeeded without errors you can remove the cloned repo
sudo rm -rf /tmp/gitolite-admin sudo rm -rf /tmp/gitolite-admin
**IMPORTANT! If you can't clone `gitolite-admin` repository - DO NOT PROCEED WITH INSTALLATION** **Impornant 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) Check the [Trouble Shooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
and ensure you have followed all of the above steps carefully. and make sure you have followed all of the above steps carefully.
# 5. Database # 5. Database
@ -130,64 +127,64 @@ See doc/install/databases.md
# 6. GitLab # 6. GitLab
We'll install GitLab into the gitlab user's home directory
cd /home/gitlab cd /home/gitlab
## Clone the Source
#### Get source code # Clone the latest stable release
# Get gitlab code. Use this for stable setup
sudo -u gitlab -H git clone -b stable https://github.com/gitlabhq/gitlabhq.git gitlab sudo -u gitlab -H git clone -b stable https://github.com/gitlabhq/gitlabhq.git gitlab
# Skip this for stable setup. **Note***
# Master branch (recent changes, less stable) You can change `stable` to `master` if you want the *bleeding edge* version, but
sudo -u gitlab -H git clone -b master https://github.com/gitlabhq/gitlabhq.git gitlab do so with caution!
## Configure it
#### Copy configs cd /home/gitlab/gitlab
cd gitlab # Copy the example GitLab config
# Rename config files
#
sudo -u gitlab -H cp config/gitlab.yml.example config/gitlab.yml sudo -u gitlab -H cp config/gitlab.yml.example config/gitlab.yml
# Copy unicorn config # Copy the example Unicorn config
#
sudo -u gitlab -H cp config/unicorn.rb.example config/unicorn.rb sudo -u gitlab -H cp config/unicorn.rb.example config/unicorn.rb
#### Install gems Make sure to edit both files to match your setup.
## Install Gems
cd /home/gitlab/gitlab cd /home/gitlab/gitlab
sudo gem install charlock_holmes --version '0.6.9' sudo gem install charlock_holmes --version '0.6.9'
sudo gem install bundler sudo gem install bundler
sudo -u gitlab -H bundle install --without development test postgres --deployment sudo -u gitlab -H bundle install --deployment --without development test
#### Configure git client ## Configure Git
Gitlab needs to be able to commit and push changes to gitolite. GitLab needs to be able to commit and push changes to Gitolite. In order to do
Git requires a username and email in order to be able to do that. that Git requires a username and email. (Please use the `email.from` address
for the email)
sudo -u gitlab -H git config --global user.name "GitLab"
sudo -u gitlab -H git config --global user.email "gitlab@localhost" sudo -u gitlab -H git config --global user.email "gitlab@localhost"
sudo -u gitlab -H git config --global user.name "Gitlab"
#### Setup application ## Setup GitLab hooks
sudo -u gitlab -H bundle exec rake gitlab:app:setup RAILS_ENV=production
#### Setup GitLab hooks
sudo cp ./lib/hooks/post-receive /home/git/.gitolite/hooks/common/post-receive sudo cp ./lib/hooks/post-receive /home/git/.gitolite/hooks/common/post-receive
sudo chown git:git /home/git/.gitolite/hooks/common/post-receive sudo chown git:git /home/git/.gitolite/hooks/common/post-receive
#### Check application status ## Initialise Database and Activate Advanced Features
Checking status: sudo -u gitlab -H bundle exec rake gitlab:app:setup RAILS_ENV=production
## Check Application Status
Just to check we didn't miss anything.
sudo -u gitlab -H bundle exec rake gitlab:app:status RAILS_ENV=production sudo -u gitlab -H bundle exec rake gitlab:app:status RAILS_ENV=production
```
# OUTPUT EXAMPLE # OUTPUT EXAMPLE
Starting diagnostic Starting diagnostic
config/database.yml............exists config/database.yml............exists
@ -202,63 +199,78 @@ Checking status:
Can clone gitolite-admin?............YES Can clone gitolite-admin?............YES
UMASK for .gitolite.rc is 0007? ............YES UMASK for .gitolite.rc is 0007? ............YES
/home/git/share/gitolite/hooks/common/post-receive exists? ............YES /home/git/share/gitolite/hooks/common/post-receive exists? ............YES
```
If you got all YES - congratulations! You can run a GitLab app. If you are all green - congratulations! You run a GitLab now.
But there are still a few steps to go.
#### init script
Create init script in /etc/init.d/gitlab: ## Install Init Script
Download the init script (will be /etc/init.d/gitlab):
sudo wget https://raw.github.com/gitlabhq/gitlab-recipes/master/init.d/gitlab -P /etc/init.d/ sudo wget https://raw.github.com/gitlabhq/gitlab-recipes/master/init.d/gitlab -P /etc/init.d/
sudo chmod +x /etc/init.d/gitlab sudo chmod +x /etc/init.d/gitlab
GitLab autostart: Make GitLab start on boot:
sudo update-rc.d gitlab defaults 21 sudo update-rc.d gitlab defaults 21
#### Now you should start GitLab application:
Start your GitLab instance:
sudo service gitlab start sudo service gitlab start
# 7. Nginx # 7. Nginx
# Install first ## Installation
sudo apt-get install nginx sudo apt-get install nginx
# Add GitLab to nginx sites & change with your host specific settings ## Site Configuration
Download an example site config:
sudo wget https://raw.github.com/gitlabhq/gitlab-recipes/master/nginx/gitlab -P /etc/nginx/sites-available/ sudo wget https://raw.github.com/gitlabhq/gitlab-recipes/master/nginx/gitlab -P /etc/nginx/sites-available/
sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab
Make sure to edit the config file to match your setup:
# Change **YOUR_SERVER_IP** and **YOUR_SERVER_FQDN** # Change **YOUR_SERVER_IP** and **YOUR_SERVER_FQDN**
# to the IP address and fully-qualified domain name # to the IP address and fully-qualified domain name
# of the host serving GitLab. # of your host serving GitLab
sudo vim /etc/nginx/sites-enabled/gitlab sudo vim /etc/nginx/sites-enabled/gitlab
# Restart nginx: ## Restart
sudo /etc/init.d/nginx restart sudo /etc/init.d/nginx restart
# Done! Visit YOUR_SERVER for gitlab instance # Done!
You can login via web using admin generated with setup: Visit YOUR_SERVER for your first GitLab login.
The setup has created an admin account for you. You can use it to log in:
admin@local.host admin@local.host
5iveL!fe 5iveL!fe
**Important Note**
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!**
- - - - - -
# Advanced setup tips: # Advanced setup tips:
## Customizing Resque's Redis connection ## Custom Redis connections
If you'd like Resque to connect to a Redis server on a non-standard port or on 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 in the a different host, you can configure its connection string via the
**config/resque.yml** file: `config/resque.yml` file.
production: redis.example.com:6379 # example
production: redis.example.tld:6379
**Ok - we have a working application now. **
**But keep going - there are some things that should be done **