140 lines
6.1 KiB
Markdown
140 lines
6.1 KiB
Markdown
#  GitLab
|
|
|
|
## 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 Community Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/) and there are mirrors to make [contributing](CONTRIBUTING.md) as easy as possible.
|
|
|
|
## Code status
|
|
|
|
- [](https://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch)
|
|
|
|
- [](https://semaphoreapp.com/gitlabhq/gitlabhq)
|
|
|
|
- [](https://codeclimate.com/github/gitlabhq/gitlabhq)
|
|
|
|
- [](https://coveralls.io/r/gitlabhq/gitlabhq?branch=master)
|
|
|
|
- [](https://www.pullreview.com/gitlab.gitlab.com/gitlab-org/gitlab-ce/reviews/master)
|
|
|
|
## Website
|
|
|
|
On [about.gitlab.com](https://about.gitlab.com/) you can find more information about:
|
|
|
|
- [Subscriptions](https://about.gitlab.com/subscription/)
|
|
- [Consultancy](https://about.gitlab.com/consultancy/)
|
|
- [Community](https://about.gitlab.com/community/)
|
|
- [Hosted GitLab.com](https://about.gitlab.com/gitlab-com/) use GitLab as a free service
|
|
- [GitLab Enterprise Edition](https://about.gitlab.com/gitlab-ee/) with additional features aimed at larger organizations.
|
|
- [GitLab CI](https://about.gitlab.com/gitlab-ci/) a continuous integration (CI) server that is easy to integrate with GitLab.
|
|
|
|
## 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](doc/install/requirements.md).
|
|
|
|
## Installation
|
|
|
|
Please see [the installation page on the GitLab website](https://about.gitlab.com/installation/) for the various options.
|
|
Since a manual installation is a lot of work and error prone we strongly recommend the fast and reliable [Omnibus package installation](https://about.gitlab.com/downloads/) (deb/rpm).
|
|
|
|
## Third-party applications
|
|
|
|
Access GitLab from multiple platforms with applications below.
|
|
These applications are maintained by contributors, GitLab B.V. does not offer support for them.
|
|
|
|
- [iPhone app](http://gitlabcontrol.com/)
|
|
- [Android app](https://play.google.com/store/apps/details?id=com.bd.gitlab&hl=en)
|
|
- [Chrome app](https://chrome.google.com/webstore/detail/chrome-gitlab-notifier/eageapgbnjicdjjihgclpclilenjbobi)
|
|
- [Command line client](https://github.com/drewblessing/gitlab-cli)
|
|
- [Ruby API wrapper](https://github.com/NARKOZ/gitlab)
|
|
|
|
### 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](https://about.gitlab.com/blog/) and in the [changelog](CHANGELOG). For more information about the release process see the release [documentation](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/release). Features that will likely be in the next releases can be found on the [feature request 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).
|
|
|
|
### Upgrading
|
|
|
|
For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update).
|
|
|
|
## 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 GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit).
|
|
If you do not use the development kit 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](https://github.com/ddollar/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](http://localhost:3000/) and login with `root` / `5iveL!fe`.
|
|
|
|
## Run the tests
|
|
|
|
- Run all tests:
|
|
|
|
bundle exec rake 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`
|
|
|
|
## Documentation
|
|
|
|
All documentation can be found on [doc.gitlab.com/ce/](http://doc.gitlab.com/ce/).
|
|
|
|
## Getting help
|
|
|
|
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
|
|
|
|
## Is it any good?
|
|
|
|
[Yes](https://news.ycombinator.com/item?id=3067434)
|
|
|
|
## Is it awesome?
|
|
|
|
Thanks for [asking this question](https://twitter.com/supersloth/status/489462789384056832) Joshua.
|
|
[These people](https://twitter.com/gitlabhq/favorites) seem to like it.
|