Gitlab2

From ArchWiki
Revision as of 10:16, 10 June 2013 by Fengchao (Talk | contribs) (Nginx and unicorn: Already exist in Gitlab.)

Jump to: navigation, search

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary end

Merge-arrows-2.pngThis article or section is a candidate for merging with Gitlab.Merge-arrows-2.png

Notes: Most of the text are the same. (Discuss in Talk:Gitlab2#)

Gitlab

Installation

Tip: If you do not want to download any documentation, add gem: --no-rdoc --no-ri to /home/gitlab/.gemrc. Be sure to add it as the gitlab user in order to acquire the appropriate permissions.

Add ruby to Gitlab's PATH:

# sudo -u gitlab -H sh -c 'echo "export PATH=$(ruby -rubygems -e "puts Gem.user_dir")/bin:$PATH" >> /home/gitlab/.bash_profile'

Install bundler and charlock_holmes:

# sudo -u gitlab -H gem install charlock_holmes --version '0.6.8'
# sudo -u gitlab -H gem install bundler
Note: When installing charlock_holmes don't mind any errors that might occur, that's normal.

Clone Gitlab's stable repository:

# cd /home/gitlab
# sudo -H -u gitlab git clone -b stable git://github.com/gitlabhq/gitlabhq.git gitlab
# cd gitlab
# sudo -u gitlab mkdir -pv tmp

Basic configuration

First we need to rename the example file.

# sudo -u gitlab cp config/gitlab.yml.example config/gitlab.yml

The options are pretty straightforward. You can skip this part as it is quite detailed. Open /home/gitlab/gitlab/config/gitlab.yml with your favorite editor and check the settings below.

Web application specific settings

/home/gitlab/gitlab/config/gitlab.yml
host: myhost.example.com
port: 80
https: false

Email used for notification

/home/gitlab/gitlab/config/gitlab.yml
from: notify@example.com

This is how the mail address will be shown for mail notifications. Gitlab needs the sendmail command in order to send emails (for things like lost password recovery, new user addition etc). This command is provided by packages such as msmtp, postfix, sendmail etc, but you can only have one of them installed. First, check whether you already have the sendmail command:

# ls /usr/sbin/sendmail

If you get a ‘cannot access /usr/bin/sendmail’ then install one of the above packages.

Application specific settings

/home/gitlab/gitlab/config/gitlab.yml
default_projects_limit: 10
# backup_path: "/vol/backups"   # default: Rails.root + backups/
# backup_keep_time: 604800      # default: 0 (forever) (in seconds)
  • default_projects_limit: As the name suggests, this integer defines the default number of projects new users have. The number can change from within Gitlab by an administrator.
  • backup_path: The path where backups are stored. Default location is /home/gitlab/gitlab/backups. The backups folder is created automatically after first backup.
  • backup_keep_time: Time to preserve backups. The default option is to never be deleted.

Also check Backup and restore.

Git Hosting configuration

/home/gitlab/gitlab/config/gitlab.yml
admin_uri: gitlab-git@localhost:gitolite-admin
base_path: /home/gitlab-git/repositories/
hooks_path: /home/gitlab-git/share/gitolite/hooks/
# host: localhost
git_user: gitlab-git
upload_pack: true
receive_pack: true
# port: 22
  • admin_uri: Do not change it. Leave as is.
  • base_path: The path where gitolite's repositories reside. If the repositories directory is different than the default one, change it here.
  • hooks_path: change default setting to /home/gitlab-git/share/gitolite/hooks/
  • host: Should point to your FQDN.
  • git_user: Name of the git user we created.
  • upload_pack:
  • receive_pack:
  • port: ssh port which git should use. Default one is 22. If you want to change it for safety reasons, do not forget to also add the port number to .ssh/config.
/home/gitlab/gitlab/.ssh/config
Host localhost
Port 5000

Git settings

/home/gitlab/gitlab/config/gitlab.yml
path: /usr/bin/git
git_max_size: 5242880 # 5.megabytes
git_timeout: 10
  • git_max_size: Max size of git objects like commits, in bytes,.This value can be increased if you have very large commits.
  • git_timeout: git timeout to read commit, in seconds.

Install gems

This could take a while as it installs all required libraries.

# cd /home/gitlab/gitlab
# source /home/gitlab/.bash_profile
# sudo -u gitlab -H bundle install --deployment
Note: Using "--without development test" in bundle command line will ignore required packages for database backup and restore


Fix for pygments.rb to work with our python2 (thanks to billyburly).

# sed -i "s/opts = {})/opts = {:python_exe => 'python'})/g" /home/gitlab/gitlab/vendor/bundle/ruby/1.9.1/bundler/gems/pygments.rb-2cada028da50/lib/pygments/ffi.rb
# ln -s /usr/bin/python2 /usr/bin/python

Start redis server

Start the daemon. If you are using initscripts you might want to add redis to your DAEMONS array in rc.conf.

Note: redis might already be running, causing a FAIL message to appear. Check if it is already running with rc.d list redis.

If you have switched to systemd, there is a service file included in the official package. See daemon how to enable it.

Populate the database

# sudo -u gitlab bundle exec rake gitlab:app:setup RAILS_ENV=production

Setup gitlab hooks

# cp ./lib/hooks/post-receive /home/gitlab-git/share/gitolite/hooks/common/post-receive
# chown gitlab-git:gitlab-git /home/gitlab-git/share/gitolite/hooks/common/post-receive

Check status

With the following command we check if the steps we followed so far are conigured properly.

# sudo -u gitlab bundle exec rake gitlab:app:status RAILS_ENV=production
Example output
Starting diagnostic
config/database.yml............exists
config/gitlab.yml............exists
/home/gitlab-git/repositories/............exists
/home/gitlab-git/repositories/ is writable?............YES
remote: Counting objects: 6, done.
remote: Compressing objects: 100% (4/4), done.
Receiving objects: 100% (6/6), 712 bytes, done.
remote: Total 6 (delta 0), reused 0 (delta 0)
Can clone gitolite-admin?............YES
UMASK for .gitolite.rc is 0007? ............YES
/home/gitlab-git/share/gitolite/hooks/common/post-receive exists? ............YES

Finished

Server testing and resque process

Resque is a Redis-backed library for creating background jobs, placing those jobs on multiple queues, and processing them later. For the backstory, philosophy, and history of Resque's beginnings, please see this blog post.

Run resque process for processing queue:

# sudo -u gitlab bundle exec rake environment resque:work QUEUE=* RAILS_ENV=production BACKGROUND=yes

or use Gitlab's start script:

# sudo -u gitlab ./resque.sh
Note: If you run this as root, /home/gitlab/gitlab/tmp/pids/resque_worker.pid will be owned by root causing the resque worker not to start via init script on next boot/service restart

Gitlab application can be started with the next command:

# sudo -u gitlab bundle exec rails s -e production

Open localhost:3000 with your favorite browser and you should see Gitlab's sign in page. In case you missed it, the default login/password are:

login.........admin@local.host
password......5iveL!fe

Since this is a thin web server, it is only for test purposes. You may close it with Template:Keypress. Follow instructions below to make Gitlab run with a real web server.

Web server configuration

Apache and unicorn

Install apache from the official repositories.

Configure Unicorn

As the official installation guide instructs, copy the unicorn configuration file:

# sudo -u gitlab -H cp /home/gitlab/gitlab/config/unicorn.rb.example /home/gitlab/gitlab/config/unicorn.rb

Now edit config/unicorn.rb and add a listening port by uncommenting the following line:

listen "127.0.0.1:8080"
Tip: You can set a custom port if you want. Just remember to also include it in Apache's virtual host. See below.

Create a virtual host for Gitlab

Create a configuration file for Gitlab’s virtual host and insert the lines below adjusted accordingly. For the ssl section see LAMP#SSL. If you do not need it, remove it. Notice that the SSL virtual host needs a specific IP instead of generic. Also if you set a custom port for Unicorn, do not forget to set it at the BalanceMember line.

# mkdir -pv /etc/httpd/conf/vhosts/
/etc/httpd/conf/vhosts/gitlab
<VirtualHost *:80>
  ServerName gitlab.myserver.com
  ServerAlias www.gitlab.myserver.com
  DocumentRoot /home/gitlab/gitlab/public
  ErrorLog /var/log/httpd/gitlab_error_log
  CustomLog /var/log/httpd/gitlab_access_log combined

  <Proxy balancer://unicornservers>
      BalancerMember http://127.0.0.1:8080
  </Proxy>

  <Directory /home/gitlab/gitlab/public>
    AllowOverride All
    Options -MultiViews
  </Directory>

  RewriteEngine on
  RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
  RewriteRule ^/(.*)$ balancer://unicornservers%{REQUEST_URI} [P,QSA,L]

  ProxyPass /uploads !
  ProxyPass / balancer://unicornservers/
  ProxyPassReverse / balancer://unicornservers/
  ProxyPreserveHost on

   <Proxy *>
      Order deny,allow
      Allow from all
   </Proxy>
</VirtualHost>

<VirtualHost MY_IP:443>
  ServerName gitlab.myserver.com
  ServerAlias www.gitlab.myserver.com
  DocumentRoot /home/gitlab/gitlab/public
  ErrorLog /var/log/httpd/gitlab_error_log
  CustomLog /var/log/httpd/gitlab_access_log combined

  <Proxy balancer://unicornservers>
      BalancerMember http://127.0.0.1:8080
  </Proxy>

  <Directory /home/gitlab/gitlab/public>
    AllowOverride All
    Options -MultiViews
  </Directory>

  RewriteEngine on
  RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
  RewriteRule ^/(.*)$ balancer://unicornservers%{REQUEST_URI} [P,QSA,L]

  ProxyPass /uploads !
  ProxyPass / balancer://unicornservers/
  ProxyPassReverse / balancer://unicornservers/
  ProxyPreserveHost on

   <Proxy *>
      Order deny,allow
      Allow from all
   </Proxy>

  SSLEngine on
  SSLCertificateFile /home/gitlab/gitlab/ssl.cert
  SSLCertificateKeyFile /home/gitlab/gitlab/ssl.key
</VirtualHost>

Enable host and start unicorn

Enable your Gitlab virtual host and reload Apache:

/etc/httpd/conf/httpd.conf
Include conf/vhosts/gitlab

Finally start unicorn:

# cd /home/gitlab/gitlab
# sudo -u gitlab bundle exec unicorn_rails -c config/unicorn.rb -E production -D

Useful Tips

Hidden options

Go to Gitlab's home directory

# cd /home/gitlab/gitlab

and run

# rake -T | grep gitlab

These are the options so far:

rake gitlab:app:backup_create      # GITLAB | Create a backup of the gitlab system
rake gitlab:app:backup_restore     # GITLAB | Restore a previously created backup
rake gitlab:app:enable_automerge   # GITLAB | Enable auto merge
rake gitlab:app:setup              # GITLAB | Setup production application
rake gitlab:app:status             # GITLAB | Check gitlab installation status
rake gitlab:gitolite:update_hooks  # GITLAB | Rewrite hooks for repos
rake gitlab:gitolite:update_keys   # GITLAB | Rebuild each key at gitolite config
rake gitlab:gitolite:update_repos  # GITLAB | Rebuild each project at gitolite config
rake gitlab:test                   # GITLAB | Run both cucumber & rspec

Backup and restore

Create a backup of the gitlab system.

# cd /home/gitlab/gitlab
# sudo -u gitlab rake gitlab:app:backup_create

Restore a previously created backup.

# cd /home/gitlab/gitlab
# sudo -u gitlab rake gitlab:app:backup_restore
Note: Backup folder is set in conig.yml. Check #Application_specific_settings.

Update Gitlab

When a new version is out follow the instructions at Github wiki. A new release is out every 22nd of a month.


Add existing gitolite repositories

Troubleshooting

Sometimes things may not work as expected. Be sure to visit the Trouble Shooting Guide.

See also