README.md 9.06 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
Daniel Bovensiepen's avatar
Daniel Bovensiepen committed
12
* Used by more than 50,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
### Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
17

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

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

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

24
### Resources
Nihad Abbasov's avatar
Nihad Abbasov committed
25

26
* 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)
27

28
* 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/)
29

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

32
* [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
33

dosire's avatar
dosire committed
34 35
* Unofficial third-party [iPhone app](http://gitlabcontrol.com/) and [Android app](https://play.google.com/store/apps/details?id=com.bd.gitlab&hl=en) for GitLab

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

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

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

46 47 48
### Installation

#### Official installation methods
49

dosire's avatar
dosire committed
50
* [GitLab packages](https://www.gitlab.com/downloads/) 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.
51 52

* [GitLab virtual machine images](https://www.gitlab.com/downloads/) contain an operating system and a preinstalled GitLab. They are made with [GitLab Packer](https://gitlab.com/gitlab-org/gitlab-packer/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

56 57
* [Manual installation guide](doc/install/installation.md) This guide to set up a production server offers detailed and complete step-by-step instructions.

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

88 89 90
### Run in development mode

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

92
    bundle exec foreman start -p 3000
93

94
or start each component separately
95

96
    bundle exec rails s
97
    script/background_jobs start
98

99
### Run the tests
100

101
* Seed the database
102

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

* Run all tests
107

108
        bundle exec rake gitlab:test RAILS_ENV=test
109

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

112 113 114
        All RSpec tests: bundle exec rake spec

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

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

118 119 120
        All Spinach tests: bundle exec rake spinach

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


123
### GitLab interfaces
124

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

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

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

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

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

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

137
### Getting help
138

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

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

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

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

nburkley's avatar
nburkley committed
147
* [Contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.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.
148 149

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

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

153
* [#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 (newton), Drew Blessing (dblessing), and Sam Gleske (sag47).
154

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

Jeroen van Baarsen's avatar
Jeroen van Baarsen committed
157
* [Gitter chat room](https://gitter.im/gitlabhq/gitlabhq#) here you can ask questions when you need help.
Jeroen van Baarsen's avatar
Jeroen van Baarsen committed
158

159

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

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

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

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