gitlabhq/README.md
2013-03-06 10:20:46 -05:00

4.4 KiB

GitLab: self hosted Git management software

logo

GitLab allows you to

  • keep your code secure on your own server
  • manage repositories, users and access permissions
  • communicate though issues, line-comments and wiki's
  • perform code reviews with merge requests

GitLab is

  • powered by Ruby on Rails
  • completely free and open source (MIT license)
  • used by 10.000 organization to keep their code secure

Code status

  • build status ci.gitlab.org (master branch)

  • build status travis-ci.org (master branch)

  • Code Climate

  • Dependency Status

Resources

Requirements

  • Ubuntu/Debian*

  • ruby 1.9.3+

  • MySQL

  • git

  • gitlab-shell

  • redis

  • More details are in the requirements doc

Installation

You can either follow the "ordinary" Installation guide to install it on a machine or use the Vagrant virtual machine. The Installation guide is recommended to set up a production server. The Vagrant virtual machine is recommended for development since it makes it much easier to set up all the dependencies for integration testing.

Starting

  1. The Installation guide contains instructions to download an init script and run that on boot. With the init script you can also start GitLab with:

     sudo service gitlab start
    

or

    sudo /etc/init.d/gitlab restart
  1. Start it with Foreman in development model

     bundle exec foreman start -p 3000
    
  2. Start it manually in development mode

     bundle exec rails s
     bundle exec rake sidekiq:start
    

Running the tests

  • Seed the database with

      bundle exec rake db:setup RAILS_ENV=test
      bundle exec rake db:seed_fu RAILS_ENV=test
    
  • Run all tests

      bundle exec rake gitlab:test
    
  • Rspec unit and functional tests

      bundle exec rake spec
    
  • Spinach integration tests

      bundle exec rake spinach
    

Getting help

New versions and the API

Each month on the 22th a new version is released together with an upgrade guide.

Other documentation

Getting in touch