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

Florian Kaiser's avatar
Florian Kaiser committed
5
![animated-screenshots](https://gist.github.com/fnkr/2f9badd56bfe0ed04ee7/raw/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 10.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

23
* [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) on travis-ci.org (master branch)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
24

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
27
* [![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
28

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

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

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

35
* 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/)
36
37

* 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
38

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

41
* Ubuntu/Debian**
42
* ruby 1.9.3
Frank Lanitz's avatar
Frank Lanitz committed
43
* MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
44
* git
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
45
* gitlab-shell
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
46
* redis
Nihad Abbasov's avatar
Nihad Abbasov committed
47

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

50
51
### Installation

52
#### Official production installation
53

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

56

57
58
59
#### 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.
60

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

63
64

#### Unsupported production installation
65
66
67
68
69

* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) for setup on different platforms

* [Unofficial installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-Installation-Guides)

70
* [BitNami one-click installers](http://bitnami.com/stack/gitlab)
71

72
* [TurnKey Linux virtual appliance](http://www.turnkeylinux.org/gitlab)
73

74
75
76

### New versions and upgrading

Tom Webster's avatar
Tom Webster committed
77
Each month on the 22nd a new version is released together with an upgrade guide.
78

79
* [Upgrade guides](doc/update)
80

81
* [Changelog](CHANGELOG)
82

83
* Features that will be in the next release are listed on [the feedback and suggestions forum with the status "started"](http://feedback.gitlab.com/forums/176466-general/status/796456).
84
85


86
### Run in production mode
87

88
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:
89

90
    sudo service gitlab start
91

92
or by directly calling the script
93

94
     sudo /etc/init.d/gitlab start
95

96
97
98
### Run in development mode

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
105
    bundle exec rails s
    bundle exec rake sidekiq:start
106

107
### Run the tests
108

109
* Seed the database
110

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

* Run all tests
115

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
116
        bundle exec rake gitlab:test
117

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

120
121
122
        All RSpec tests: bundle exec rake spec

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

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

126
127
128
        All Spinach tests: bundle exec rake spinach

        Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
129
130


131
### GitLab interfaces
132

133
* [GitLab API](doc/api/README.md)
134

135
* [Rake tasks](doc/raketasks)
136

137
* [Directory structure](doc/install/structure.md)
138

139
* [Databases](doc/install/databases.md)
140
141


142
### Getting help
143

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

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

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

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

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

154
155
156
* [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.
157

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


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

163
* [Core team](https://github.com/gitlabhq?tab=members)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
164

165
* [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
Nihad Abbasov's avatar
Nihad Abbasov committed
166

167
* [Leader](https://github.com/randx)
Nihad Abbasov's avatar
Nihad Abbasov committed
168

169
* [Contact page](http://gitlab.org/contact/)