1 ## GitLab: self hosted Git management software
3 ![logo](https://raw.github.com/gitlabhq/gitlabhq/master/public/gitlab_logo.png)
5 ### GitLab allows you to
6 * keep your code secure on your own server
7 * manage repositories, users and access permissions
8 * communicate through issues, line-comments and wiki pages
9 * perform code review with merge requests
13 * powered by Ruby on Rails
14 * completely free and open source (MIT license)
15 * used by more than 10.000 organizations to keep their code secure
19 * [![build status](http://ci.gitlab.org/projects/1/status.png?ref=master)](http://ci.gitlab.org/projects/1?ref=master) ci.gitlab.org (master branch)
21 * [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) travis-ci.org (master branch)
23 * [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
25 * [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq)
27 * [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq)
31 * GitLab.org community site: [Homepage](http://gitlab.org) [Screenshots](http://gitlab.org/screenshots/) [Blog](http://blog.gitlab.org/) [Demo](http://demo.gitlabhq.com/users/sign_in)
33 * GitLab.com commercial services: [Homepage](http://www.gitlab.com/) [Subscription](http://www.gitlab.com/subscription/) [Consultancy](http://www.gitlab.com/consultancy/) [GitLab Cloud](http://www.gitlab.com/cloud/) [Blog](http://blog.gitlab.com/)
35 * GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server
46 ** More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)
50 Check out our [maintenance policy](MAINTENANCE.md) to see what versions are supported.
52 #### Official production installation
54 * [Installation guide for a production server](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)
57 #### Official development installation
59 If you want to contribute, please first read our [Contributing Guidelines](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) and then we suggest you to use the Vagrant virtual machine project to get an environment working with all dependencies.
61 * [Vagrant virtual machine for development](https://github.com/gitlabhq/gitlab-vagrant-vm)
64 #### Unsupported production installation
66 * [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) for setup on different platforms
68 * [Unofficial installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-Installation-Guides)
70 * [BitNami one-click installers](http://bitnami.com/stack/gitlab)
72 * [TurnKey Linux virtual appliance](http://www.turnkeylinux.org/gitlab)
75 ### New versions and upgrading
77 Each month on the 22th a new version is released together with an upgrade guide.
79 * [Upgrade guides](https://github.com/gitlabhq/gitlabhq/tree/master/doc/update)
81 * [Changelog](https://github.com/gitlabhq/gitlabhq/blob/master/CHANGELOG)
83 * Features that will be in the next release are listed on [the feedback and suggestions forum with the status "started"](http://feedback.gitlab.com/forums/176466-general/status/796456).
86 ### Run in production mode
88 1. 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:
90 sudo service gitlab start
92 or by directly calling the script
94 sudo /etc/init.d/gitlab start
96 ### Run in development mode
98 Start it with [Foreman](https://github.com/ddollar/foreman)
100 bundle exec foreman start -p 3000
102 or start each component separately
105 bundle exec rake sidekiq:start
111 bundle exec rake db:setup RAILS_ENV=test
112 bundle exec rake db:seed_fu RAILS_ENV=test
116 bundle exec rake gitlab:test
118 * [RSpec](http://rspec.info/) unit and functional tests
120 bundle exec rake spec
122 * [Spinach](https://github.com/codegram/spinach) integration tests
124 bundle exec rake spinach
127 ### GitLab interfaces
129 * [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
131 * [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
133 * [Directory structure](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/structure.md)
135 * [Databases](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/databases.md)
140 * [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) contains solutions to common problems.
142 * [Support forum](https://groups.google.com/forum/#!forum/gitlabhq) is the best place to ask questions. For example you can use it if you have questions about: permission denied errors, invisible repos, can't clone/pull/push or with web hooks that don't fire. Please search for similar issues before posting your own, there's a good chance somebody else had the same issue you have now and had it resolved. There are a lot of helpful GitLab users there who may be able to help you quickly. If your particular issue turns out to be a bug, it will find its way from there to a fix.
144 * [Feedback and suggestions forum](http://feedback.gitlab.com) is the place to propose and discuss new features for GitLab.
146 * [Support subscription](http://www.gitlab.com/subscription/) connect you to the knowledge of GitLab experts that will resolve your issues and answer your questions.
148 * [Consultancy](http://www.gitlab.com/consultancy/) allows you hire GitLab experts for installations, upgrades and customizations.
150 * [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) describes how to submit pull requests and issues. Pull requests and issues not in line with the guidelines in this document will be closed.
155 * [Core team](https://github.com/gitlabhq?tab=members)
157 * [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
159 * [Leader](https://github.com/randx)
161 * [Contact page](http://gitlab.org/contact/)