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

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
3
![logo](https://raw.github.com/gitlabhq/gitlabhq/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

* GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server
Nihad Abbasov's avatar
Nihad Abbasov committed
36

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

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

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

47
48
### Installation

49
#### Official production installation
50

51
* [Installation guide for a production server](doc/install/installation.md)
52

53

54
55
56
#### Official development installation

If you want to contribute, please first read our [Contributing Guidelines](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) and then we suggest you to use the Vagrant virtual machine project to get an environment working with all dependencies.
57

58
* [Vagrant virtual machine for development](https://github.com/gitlabhq/gitlab-vagrant-vm)
59

60

61
#### Unofficial production installations
62

63
* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) repository with unofficial guides for using GitLab with different software (operating systems, webservers, etc.) than the official version.
64

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


68
69
70
* [Digital Ocean 1-Click Application Install](https://www.digitalocean.com/) Have a new server up in 55 seconds. Digital Ocean uses SSD disks which is great for an IO intensive app as GitLab. Look for GitLab under 'Select Image' => 'Applications' when creating a droplet.

* [BitNami one-click installers](http://bitnami.com/stack/gitlab) Get an image with GitLab and GitLab CI preinstalled for Amazon Web Services, Azure, VMware or your local server.
71

72
73
74

### New versions and upgrading

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

77
* [Upgrade guides](doc/update)
78

79
* [Changelog](CHANGELOG)
80

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

94
95
96
### Run in development mode

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

98
    bundle exec foreman start -p 3000
99

100
or start each component separately
101

102
    bundle exec rails s
103
    script/background_jobs start
104

105
### Run the tests
106

107
* Seed the database
108

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
109
110
        bundle exec rake db:setup RAILS_ENV=test
        bundle exec rake db:seed_fu RAILS_ENV=test
111
112

* Run all tests
113

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
114
        bundle exec rake gitlab:test
115

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

118
119
120
        All RSpec tests: bundle exec rake spec

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

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

124
125
126
        All Spinach tests: bundle exec rake spinach

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


129
### GitLab interfaces
130

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

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

135
* [Directory structure](doc/install/structure.md)
136

137
* [Database installation](doc/install/databases.md)
138

139
140
141
* [Markdown specification](doc/markdown/markdown.md)

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

143
### Getting help
144

145
146
* [Maintenance policy](MAINTENANCE.md) specifies what versions are supported.

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

149
* [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.
150

151
152
* [Unofficial #gitlab IRC on Freenode](http://www.freenode.net/) is another way to get in touch with other GitLab users who may be able to help you.

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

155
156
157
* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) describes how to submit pull requests and issues. Pull requests and issues not in line with the guidelines in this document will be closed.

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

Yves Senn's avatar
Yves Senn committed
159
* [Consultancy](http://www.gitlab.com/consultancy/) allows you hire GitLab experts for installations, upgrades and customizations.
160
161


162
### Getting in touch
Nihad Abbasov's avatar
Nihad Abbasov committed
163

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

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

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