README.md 7.52 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
dosire's avatar
dosire committed
12
* Used by more than 100,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
17
### Canonical source

18
* 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.
19

20
### Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
21

dosire's avatar
dosire committed
22
* [![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
23

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

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

dosire's avatar
dosire committed
28
29
* [![PullReview stats](https://www.pullreview.com/gitlab/gitlab-org/gitlab-ce/badges/master.svg?)](https://www.pullreview.com/gitlab.gitlab.com/gitlab-org/gitlab-ce/reviews/master)

30
### Resources
Nihad Abbasov's avatar
Nihad Abbasov committed
31

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

34
* [GitLab Enterprise Edition](https://www.gitlab.com/gitlab-ee/) offers additional features aimed at larger organizations.
35

dosire's avatar
dosire committed
36
* [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
37

38
* Unofficial third-party [iPhone app](http://gitlabcontrol.com/), [Android app](https://play.google.com/store/apps/details?id=com.bd.gitlab&hl=en) and [command line client](https://github.com/drewblessing/gitlab-cli) and [Ruby API wrapper](https://github.com/NARKOZ/gitlab) for GitLab.
dosire's avatar
dosire committed
39

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
40
### Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
41

42
* Ubuntu/Debian/CentOS/RHEL**
43
44
45
* ruby 1.9.3+
* git 1.7.10+
* redis 2.0+
Frank Lanitz's avatar
Frank Lanitz committed
46
* MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
47

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

50
51
52
### Installation

#### Official installation methods
53

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

dosire's avatar
dosire committed
56
* [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](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/doc/development.md) instructions to install all testing dependencies.
57

dosire's avatar
dosire committed
58
* [Manual installation guide](doc/install/installation.md) This guide to set up a production server on Ubuntu offers detailed and complete step-by-step instructions.
59

60
#### Third party one-click installers
61

62
* [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).
63

64
* [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.).
65

66
* [Cloud 66 deployment and management](http://blog.cloud66.com/installing-gitlab-ubuntu/) Use Cloud 66 to deploy GitLab to your own server or any cloud (eg. DigitalOcean, AWS, Rackspace, GCE) and then manage it with database backups, scaling and more.
67

68
69
* [Pkgr.io one-click installer](https://pkgr.io/apps/gitlabhq/gitlabhq) Currently supporting Ubuntu 14.04, Ubuntu 12.04 and Debian 7.4. For more information check the [README](https://gitlab.com/gitlab-org/gitlab-recipes/blob/master/install/pkgr/README.md) at gitlab-recipes repo.

70
#### Unofficial installation methods
71

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

74
* [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.
75

76
77
### New versions and upgrading

78
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).
79

80
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.
81

82
* 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).
83

84
### Run in production mode
85

86
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:
87

88
    sudo service gitlab start
89

90
or by directly calling the script
91

92
     sudo /etc/init.d/gitlab start
93

dosire's avatar
dosire committed
94
95
Please login with root / 5iveL!fe

96
97
### Run in development mode

dosire's avatar
dosire committed
98
99
Consider setting up the development environment with [the cookbook](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/README.md#installation).

Marin Jankovski's avatar
Marin Jankovski committed
100
101
102
103
Copy the example development unicorn configuration file

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

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

106
    bundle exec foreman start -p 3000
107

108
or start each component separately
109

110
    bundle exec rails s
111
    bin/background_jobs start
112

dosire's avatar
dosire committed
113
114
And surf to [localhost:3000](http://localhost:3000/) and login with root / 5iveL!fe

115
### Run the tests
116
117

* Run all tests
118

119
        bundle exec rake test
120

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

123
124
125
        All RSpec tests: bundle exec rake spec

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

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

129
130
131
        All Spinach tests: bundle exec rake spinach

        Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
132
133


dosire's avatar
dosire committed
134
### Documentation
135

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

138
### Getting help
139

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