gitlab-org--gitlab-foss/README.md
Dmitriy Zaporozhets b1ce97d5a1 Merge branch 'updating-readme' into 'master'
Updating readme
2014-05-29 11:35:10 +00:00

5.3 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 100,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

Canonical source

Code status

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

  • Code Climate

  • Coverage Status

  • PullReview stats

Resources

Requirements

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

** More details are in the requirements doc

Installation

Please see the installation page on the GitLab website.

New versions

Since 2011 a minor or major version of GitLab is released on the 22nd of every month. Patch and security releases come out when needed. New features are detailed on the blog and in the changelog. For more information about the release process see the release documentation. Features that will likely be in the next releases can be found on the feature request forum with the status started and completed.

Upgrading

For updating the the Omnibus installation please see the update documentation. For manual installations there is an upgrader script and there are upgrade guides.

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

Please login with root / 5iveL!fe

Install a development environment

We recommend setting up your development environment with the cookbook. If you do not use the cookbook you might need to copy the example development unicorn configuration file

cp config/unicorn.rb.example.development config/unicorn.rb

Run in development mode

Start it with Foreman

bundle exec foreman start -p 3000

or start each component separately

bundle exec rails s
bin/background_jobs start

And surf to localhost:3000 and login with root / 5iveL!fe

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.