README.md 6.54 KB
Newer Older
1
## GitLab: self hosted Git management software
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
2

3
![logo](https://gitlab.com/gitlab-org/gitlab-ce/raw/master/public/gitlab_logo.png)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
4

5
![animated-screenshots](https://gist.github.com/fnkr/2f9badd56bfe0ed04ee7/raw/4f48806fbae97f556c2f78d8c2d299c04500cb0d/compiled.gif)
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
6

dosire's avatar
dosire committed
7
8
9
10
11
### 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
Daniel Bovensiepen's avatar
Daniel Bovensiepen committed
12
* Used by more than 50,000 organizations, GitLab is the most popular solution to manage git repositories on-premises
dosire's avatar
dosire committed
13
14
* Completely free and open source (MIT Expat license)
* Powered by Ruby on Rails
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
15

16
### Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
17

dosire's avatar
dosire committed
18
* [![build status](https://ci.gitlab.org/projects/1/status.png?ref=master)](https://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch)
Nihad Abbasov's avatar
Nihad Abbasov committed
19

Un1matr1x's avatar
Un1matr1x committed
20
* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
21

22
23
* [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq)

24
### Resources
Nihad Abbasov's avatar
Nihad Abbasov committed
25

dosire's avatar
dosire committed
26
* [GitLab.com](https://www.gitlab.com/) includes information about [subscriptions](https://www.gitlab.com/subscription/), [consultancy](https://www.gitlab.com/consultancy/), the [community](https://www.gitlab.com/community/) and the [hosted GitLab Cloud](https://www.gitlab.com/cloud/).
27

dosire's avatar
dosire committed
28
* [GitLab Enterprise Edition](https://www.gitlab.com/gitlab-ce/) offers additional features that are useful for larger organizations (100+ users).
29

dosire's avatar
dosire committed
30
* [GitLab CI](https://www.gitlab.com/gitlab-ci/) is a continuous integration (CI) server that is easy to integrate with GitLab.
Nihad Abbasov's avatar
Nihad Abbasov committed
31

dosire's avatar
dosire committed
32
33
* 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

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
34
### Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
35

36
* Ubuntu/Debian/CentOS/RHEL**
37
38
39
* ruby 1.9.3+
* git 1.7.10+
* redis 2.0+
Frank Lanitz's avatar
Frank Lanitz committed
40
* MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
41

42
** More details are in the [requirements doc](doc/install/requirements.md)
43

44
45
46
### Installation

#### Official installation methods
47

48
* [GitLab packages](https://www.gitlab.com/downloads/) **Recommended** These packages contain GitLab and all its depencies (Ruby, 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.
49
50

* [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.
51

52
* [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.
53

54
55
* [Manual installation guide](doc/install/installation.md) This guide to set up a production server offers detailed and complete step-by-step instructions.

56
#### Third party one-click installers
57

58
* [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).
59

60
* [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.).
61

62
#### Unofficial installation methods
63

dosire's avatar
dosire committed
64
* [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.
65

66
* [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.
67

68
69
### New versions and upgrading

70
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).
71

72
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.
73

74
* Features that will be in the next releases are listed 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).
75

76
### Run in production mode
77

78
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:
79

80
    sudo service gitlab start
81

82
or by directly calling the script
83

84
     sudo /etc/init.d/gitlab start
85

86
87
### Run in development mode

Marin Jankovski's avatar
Marin Jankovski committed
88
89
90
91
Copy the example development unicorn configuration file

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

92
Start it with [Foreman](https://github.com/ddollar/foreman)
93

94
    bundle exec foreman start -p 3000
95

96
or start each component separately
97

98
    bundle exec rails s
99
    script/background_jobs start
100

101
### Run the tests
102
103

* Run all tests
104

105
        bundle exec rake test
106

107
* [RSpec](http://rspec.info/) unit and functional tests
108

109
110
111
        All RSpec tests: bundle exec rake spec

        Single RSpec file: bundle exec rspec spec/controllers/commit_controller_spec.rb
112

113
* [Spinach](https://github.com/codegram/spinach) integration tests
114

115
116
117
        All Spinach tests: bundle exec rake spinach

        Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
118
119


dosire's avatar
dosire committed
120
### Documentation
121

dosire's avatar
dosire committed
122
All documentation can be found on [doc.gitlab.com/ce/](http://doc.gitlab.com/ce/).
123

124
### Getting help
125

dosire's avatar
dosire committed
126
Please see [Getting help for GitLab](https://www.gitlab.com/getting-help/) on our website for the many options to get help.