gitlab-org--gitlab-foss/README.md
2014-04-01 09:19:37 +02:00

6.4 KiB

GitLab: self hosted Git management software

logo

animated-screenshots

Gitlab is open source software to collaborate on code

  • Manage git repositories with fine grained access controls that keep your code secure
  • Perform code reviews and enhance collaboration with merge requests
  • Each project can also have an issue tracker and a wiki
  • Used by more than 50,000 organizations, GitLab is the most popular solution to manage git repositories on-premises
  • Completely free and open source (MIT Expat license)
  • Powered by Ruby on Rails

Code status

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

  • Code Climate

  • Coverage Status

Resources

Requirements

  • Ubuntu/Debian/CentOS/RHEL**
  • ruby 1.9.3+
  • git 1.7.10+
  • redis 2.0+
  • MySQL or PostgreSQL

** More details are in the requirements doc

Installation

Official installation methods

Third party one-click installers

Unofficial installation methods

  • GitLab recipes repository with unofficial guides for using GitLab with different software (operating systems, webservers, etc.) than the official version.

  • Installation guides public wiki with unofficial guides to install GitLab on different operating systems.

New versions and upgrading

Since 2011 GitLab is released on the 22nd of every month. Every new release includes an upgrade guide and new features are detailed in the Changelog.

It is recommended to follow a monthly upgrade schedule. Security releases come out when needed. For more information about the release process see the documentation for monthly and security releases.

Run in production mode

The Installation guide contains instructions on how to download an init script and run it automatically on boot. You can also start the init script manually:

sudo service gitlab start

or by directly calling the script

 sudo /etc/init.d/gitlab start

Run in development mode

Start it with Foreman

bundle exec foreman start -p 3000

or start each component separately

bundle exec rails s
script/background_jobs start

Run the tests

  • Run all tests

      bundle exec rake test
    
  • RSpec unit and functional tests

      All RSpec tests: bundle exec rake spec
    
      Single RSpec file: bundle exec rspec spec/controllers/commit_controller_spec.rb
    
  • Spinach integration tests

      All Spinach tests: bundle exec rake spinach
    
      Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
    

Documentation

All documentation can be found on doc.gitlab.com/ce/.

Getting help

Please see Getting help for GitLab on our website for the many options to get help.