README.md 7.83 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

7
8
9
### GitLab allows you to
 * keep your code secure on your own server
 * manage repositories, users and access permissions
10
11
 * communicate through issues, line-comments and wiki pages
 * perform code review with merge requests
12
13

### GitLab is
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
14

15
16
* powered by Ruby on Rails
* completely free and open source (MIT license)
17
* used by more than 25.000 organizations to keep their code secure
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
18

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

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

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
25
* [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq) this button can be yellow (small updates are available) but must not be red (a security fix or an important update is available), gems are updated in major releases of GitLab.
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
26

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

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

31
* 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)
32

33
* 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/)
34

35
36
* [GitLab Enterprise Edition](https://www.gitlab.com/features/) offers additional features that are useful for larger organizations (100+ users).

37
* [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.
Nihad Abbasov's avatar
Nihad Abbasov committed
38

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

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

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

49
50
51
### Installation

#### Official installation methods
52

53
* [Manual installation guide for a production server](doc/install/installation.md)
54

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

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

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

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

63
#### Unofficial installation methods
64

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

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

69
70
### New versions and upgrading

71
Since 2011 GitLab is released on the 22nd of every month. Every new release includes an upgrade guide.
72

73
* [Upgrade guides](doc/update)
74

75
* [Changelog](CHANGELOG)
76

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
77
* 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).
78

79
### Run in production mode
80

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

83
    sudo service gitlab start
84

85
or by directly calling the script
86

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

89
90
91
### Run in development mode

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

93
    bundle exec foreman start -p 3000
94

95
or start each component separately
96

97
    bundle exec rails s
98
    script/background_jobs start
99

100
### Run the tests
101

102
* Seed the database
103

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
104
105
        bundle exec rake db:setup RAILS_ENV=test
        bundle exec rake db:seed_fu RAILS_ENV=test
106
107

* Run all tests
108

109
        bundle exec rake gitlab:test RAILS_ENV=test
110

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

113
114
115
        All RSpec tests: bundle exec rake spec

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

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

119
120
121
        All Spinach tests: bundle exec rake spinach

        Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
122
123


124
### GitLab interfaces
125

126
* [GitLab API doc](doc/api/README.md) or see the [GitLab API website](http://api.gitlab.org/)
127

128
* [Rake tasks](doc/raketasks) including a [backup and restore procedure](doc/raketasks/backup_restore.md)
129

130
* [Directory structure](doc/install/structure.md)
131

132
* [Database installation](doc/install/databases.md)
133

134
135
136
* [Markdown specification](doc/markdown/markdown.md)

* [Security guide](doc/security/rack_attack.md) to throttle abusive requests
137

138
### Getting help
139

140
141
* [Maintenance policy](MAINTENANCE.md) specifies what versions are supported.

142
* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) contains solutions to common problems.
143

144
* [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.
145

146
* [Feedback and suggestions forum](http://feedback.gitlab.com) is the place to propose and discuss new features for GitLab.
147

148
* [Contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/masterCONTRIBUTING.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.
149
150

* [Support subscription](http://www.gitlab.com/subscription/) connects you to the knowledge of GitLab experts that will resolve your issues and answer your questions.
151

152
153
* [Consultancy](http://www.gitlab.com/consultancy/) from the GitLab experts for installations, upgrades and customizations.

Sid Sijbrandij's avatar
Sid Sijbrandij committed
154
* [#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, Drew Blessing and Sam Gleske
155

156
* [Book](http://www.packtpub.com/gitlab-repository-management/book) written by GitLab enthusiast Jonathan M. Hethey is unofficial but it offers a good overview.
157
158


159
### Getting in touch
Nihad Abbasov's avatar
Nihad Abbasov committed
160

161
* [Core team](http://gitlab.org/team/)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
162

163
* [Contributors](http://contributors.gitlab.org/)
Nihad Abbasov's avatar
Nihad Abbasov committed
164

165
* [Community](http://gitlab.org/community/)