166 lines
9.2 KiB
Markdown
166 lines
9.2 KiB
Markdown
## 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 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
|
|
|
|
* [](https://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch)
|
|
|
|
* [](https://codeclimate.com/github/gitlabhq/gitlabhq)
|
|
|
|
* [](https://coveralls.io/r/gitlabhq/gitlabhq)
|
|
|
|
### Resources
|
|
|
|
* 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)
|
|
|
|
* 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/)
|
|
|
|
* [GitLab Enterprise Edition](https://www.gitlab.com/features/) offers additional features that are useful for larger organizations (100+ users).
|
|
|
|
* [GitLab CI](https://gitlab.com/gitlab-org/gitlab-ci/blob/master/README.md) is a continuous integration (CI) server that is easy to integrate with GitLab.
|
|
|
|
* Unofficial third-party [iPhone app](http://gitlabcontrol.com/) and [Android app](https://play.google.com/store/apps/details?id=com.bd.gitlab&hl=en) for GitLab
|
|
|
|
### Requirements
|
|
|
|
* Ubuntu/Debian**
|
|
* ruby 1.9.3+
|
|
* git 1.7.10+
|
|
* redis 2.0+
|
|
* MySQL or PostgreSQL
|
|
|
|
** More details are in the [requirements doc](doc/install/requirements.md)
|
|
|
|
### Installation
|
|
|
|
#### Official installation methods
|
|
|
|
* [GitLab packages (beta)](https://www.gitlab.com/downloads/) These packages contain GitLab and all its depencies (PostgreSQL, Redis, Nginx, Unicorn, etc.). They are made with [omnibus-gitlab](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/README.md) that also contains the installation instructions. These packages currently support a reduced selection of GitLab's normal features. For instance, it is not yet possible to create/restore application backups or to use HTTPS.
|
|
|
|
* [GitLab virtual machine images](https://www.gitlab.com/downloads/) contain an operating system and a preinstalled GitLab. They are made with [GitLab Packer](https://gitlab.com/gitlab-org/gitlab-packer/blob/master/README.md) that also contains the installation instructions.
|
|
|
|
* [GitLab Chef Cookbook](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/README.md) This cookbook can be used both for development installations and production installations. If you want to [contribute](CONTRIBUTE.md) to GitLab we suggest you follow the [development installation on a virtual machine with Vagrant](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/doc/development.md) instructions to install all testing dependencies.
|
|
|
|
* [Manual installation guide](doc/install/installation.md) This guide to set up a production server offers detailed and complete step-by-step instructions.
|
|
|
|
#### Third party one-click installers
|
|
|
|
* [Digital Ocean 1-Click Application Install](https://www.digitalocean.com/blog_posts/host-your-git-repositories-in-55-seconds-with-gitlab) 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](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md).
|
|
|
|
* [BitNami one-click installers](http://bitnami.com/stack/gitlab) 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](https://gitlab.com/gitlab-org/gitlab-recipes/) repository with unofficial guides for using GitLab with different software (operating systems, webservers, etc.) than the official version.
|
|
|
|
* [Installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-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](doc/update) and new features are detailed in the [Changelog](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](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/release/monthly.md) and [security](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/release/security.md) releases.
|
|
|
|
* Features that will be in the next releases are listed on [the feedback and suggestions forum](http://feedback.gitlab.com/forums/176466-general) with the status [started](http://feedback.gitlab.com/forums/176466-general/status/796456) and [completed](http://feedback.gitlab.com/forums/176466-general/status/796457).
|
|
|
|
### 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](https://github.com/ddollar/foreman)
|
|
|
|
bundle exec foreman start -p 3000
|
|
|
|
or start each component separately
|
|
|
|
bundle exec rails s
|
|
script/background_jobs start
|
|
|
|
### Run the tests
|
|
|
|
* Seed the database
|
|
|
|
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 RAILS_ENV=test
|
|
|
|
* [RSpec](http://rspec.info/) unit and functional tests
|
|
|
|
All RSpec tests: bundle exec rake spec
|
|
|
|
Single RSpec file: bundle exec rspec spec/controllers/commit_controller_spec.rb
|
|
|
|
* [Spinach](https://github.com/codegram/spinach) integration tests
|
|
|
|
All Spinach tests: bundle exec rake spinach
|
|
|
|
Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
|
|
|
|
|
|
### GitLab interfaces
|
|
|
|
* [GitLab API doc](doc/api/README.md) or see the [GitLab API website](http://api.gitlab.org/)
|
|
|
|
* [Rake tasks](doc/raketasks) including a [backup and restore procedure](doc/raketasks/backup_restore.md)
|
|
|
|
* [Directory structure](doc/install/structure.md)
|
|
|
|
* [Database installation](doc/install/databases.md)
|
|
|
|
* [Markdown specification](doc/markdown/markdown.md)
|
|
|
|
* [Security guide](doc/security/rack_attack.md) to throttle abusive requests
|
|
|
|
### Getting help
|
|
|
|
* [Maintenance policy](MAINTENANCE.md) specifies what versions are supported.
|
|
|
|
* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) contains solutions to common problems.
|
|
|
|
* [Mailing list](https://groups.google.com/forum/#!forum/gitlabhq) and [Stack Overflow](http://stackoverflow.com/questions/tagged/gitlab) are the best places 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 has resolved it. 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.
|
|
|
|
* [Feedback and suggestions forum](http://feedback.gitlab.com) is the place to propose and discuss new features for GitLab.
|
|
|
|
* [Contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md) describes how to submit merge requests and issues. Pull requests and issues not in line with the guidelines in this document will be closed.
|
|
|
|
* [Support subscription](http://www.gitlab.com/subscription/) connects you to the knowledge of GitLab experts that will resolve your issues and answer your questions.
|
|
|
|
* [Consultancy](http://www.gitlab.com/consultancy/) from the GitLab experts for installations, upgrades and customizations.
|
|
|
|
* [#gitlab IRC channel](http://www.freenode.net/) on Freenode to get in touch with other GitLab users and get help, it's managed by James Newton (newton), Drew Blessing (dblessing), and Sam Gleske (sag47).
|
|
|
|
* [Book](http://www.packtpub.com/gitlab-repository-management/book) written by GitLab enthusiast Jonathan M. Hethey is unofficial but it offers a good overview.
|
|
|
|
* [Gitter chat room](https://gitter.im/gitlabhq/gitlabhq#) here you can ask questions when you need help.
|
|
|
|
|
|
### Getting in touch
|
|
|
|
* [Core team](http://gitlab.org/team/)
|
|
|
|
* [Contributors](http://contributors.gitlab.org/)
|
|
|
|
* [Community](http://gitlab.org/community/)
|