gitlab-org--gitlab-foss/README.md

GitLab: self hosted Git management software

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

• The source of GitLab Communinity Edition is hosted on GitLab Cloud and there are mirrors to make contributing as easy as possible.

Code status

• on ci.gitlab.org (master branch)

• 

• 

• 

Resources

• GitLab.com includes information about subscriptions, consultancy, the community and the hosted GitLab Cloud.

• GitLab Enterprise Edition offers additional features aimed at larger organizations.

• GitLab CI is a continuous integration (CI) server that is easy to integrate with GitLab.

• Unofficial third-party iPhone app, Android app and command line client and Ruby API wrapper for GitLab.

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

• GitLab packages recommended These packages contain GitLab and all its depencies (Ruby, PostgreSQL, Redis, Nginx, Unicorn, etc.). They are made with omnibus-gitlab that also contains the installation instructions.

• GitLab Chef Cookbook This cookbook can be used both for development installations and production installations. If you want to contribute to GitLab we suggest you follow the development installation on a virtual machine with Vagrant instructions to install all testing dependencies.

• Manual installation guide This guide to set up a production server on Ubuntu offers detailed and complete step-by-step instructions.

Third party one-click installers

• Digital Ocean 1-Click Application Install Have a new server up in 55 seconds. Digital Ocean uses SSD disks which is great for an IO intensive app such as GitLab. We recommend selecting a droplet with 1GB of memory.

• BitNami one-click installers This package contains both GitLab and GitLab CI. It is available as installer, virtual machine or for cloud hosting providers (Amazon Web Services/Azure/etc.).

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.

• Features that will be in the next releases are listed on the feature request forum with the status started and completed.

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

Run in development mode

Consider setting up the development environment with the cookbook.

Copy the example development unicorn configuration file

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

Start it with Foreman

bundle exec foreman start -p 3000

or start each component separately

bundle exec rails s
script/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.