README.md 6.86 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
18
19
### Canonical source

* The source of GitLab Communinity Edition is [hosted on GitLab Cloud](https://gitlab.com/gitlab-org/gitlab-ce/) and there are mirrors to make [contributing](CONTRIBUTING.md) as easy as possible.

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)

28
### Resources
Nihad Abbasov's avatar
Nihad Abbasov committed
29

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

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

dosire's avatar
dosire committed
34
* [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
35

36
* 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
37

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
38
### Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
39

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

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

48
49
50
### Installation

#### Official installation methods
51

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

54
* [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.
55

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

58
#### Third party one-click installers
59

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

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

64
#### Unofficial installation methods
65

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

68
* [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.
69

70
71
### New versions and upgrading

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

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

76
* 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).
77

78
### Run in production mode
79

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

82
    sudo service gitlab start
83

84
or by directly calling the script
85

86
     sudo /etc/init.d/gitlab start
87

dosire's avatar
dosire committed
88
89
Please login with root / 5iveL!fe

90
91
### Run in development mode

dosire's avatar
dosire committed
92
93
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
94
95
96
97
Copy the example development unicorn configuration file

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

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

100
    bundle exec foreman start -p 3000
101

102
or start each component separately
103

104
    bundle exec rails s
105
    script/background_jobs start
106

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

109
### Run the tests
110
111

* Run all tests
112

113
        bundle exec rake test
114

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

117
118
119
        All RSpec tests: bundle exec rake spec

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

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

123
124
125
        All Spinach tests: bundle exec rake spinach

        Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
126
127


dosire's avatar
dosire committed
128
### Documentation
129

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

132
### Getting help
133

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