README.md 6.89 KB
Newer Older
1
# ![logo](https://about.gitlab.com/images/gitlab_logo.png) GitLab
2

Valery Sizov's avatar
Valery Sizov committed
3
4
For upgrading from GitLab CE to GitLab EE there is [upgrade guide](doc/update/7.4-ce-to-ee.md)

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
## Subscriber onboarding information

Thank you for purchasing a GitLab subscription!

For standard subscribers, please see [the Standard subscribers README](https://gitlab.com/standard/standard-subscriber-information/tree/master#README).

If you would like to receive access to GitLab Enterprise Edition please create an account on https://gitlab.com/users/sign_up and send us the username. Note that your user will be visible to other Support Subscribers.

Once your username is added, you can find the repository here:
https://gitlab.com/subscribers/gitlab-ee

Packages:
https://gitlab.com/subscribers/gitlab-ee/blob/master/doc/install/packages.md

Documentation:
http://doc.gitlab.com/ee/

To upgrade from CE, just perform a normal upgrade, but make use of an EE package:
https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md#updating-from-gitlab-6-6-x-and-higher-to-the-latest-version

If you need help with your GitLab installation and for any technical questions please contact us at subscribers@gitlab.com.

For all other questions, contact us at sales@gitlab.com 

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
29
## Open source software to collaborate on code
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
30

31
![Animated screenshots](https://about.gitlab.com/images/animated/compiled.gif)
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
32

33
34
35
36
37
38
- 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
- Used by more than 100,000 organizations, GitLab is the most popular solution to manage Git repositories on-premises
- Completely free and open source (MIT Expat license)
- Powered by Ruby on Rails
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
39

40
## Canonical source
41

42
- The source of GitLab Enterprise Edition is [hosted on GitLab.com](https://dev.gitlab.org/gitlab/gitlab-ee/) and acessible only to [subscribers](https://about.gitlab.com/subscription/).
43

44
## Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
45

46
- [![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
47

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
48
49
- [![Build Status](https://semaphoreapp.com/api/v1/projects/2f1a5809-418b-4cc2-a1f4-819607579fe7/243338/badge.png)](https://semaphoreapp.com/gitlabhq/gitlabhq)

50
- [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
51

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
52
- [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq?branch=master)
53

54
- [![PullReview stats](https://www.pullreview.com/gitlab/gitlab-org/gitlab-ce/badges/master.svg?)](https://www.pullreview.com/gitlab.gitlab.com/gitlab-org/gitlab-ce/reviews/master)
dosire's avatar
dosire committed
55

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
56
57
## Website

58
On [about.gitlab.com](https://about.gitlab.com/) you can find more information about:
Nihad Abbasov's avatar
Nihad Abbasov committed
59

60
61
62
63
64
65
- [Subscriptions](https://about.gitlab.com/subscription/)
- [Consultancy](https://about.gitlab.com/consultancy/)
- [Community](https://about.gitlab.com/community/)
- [Hosted GitLab.com](https://about.gitlab.com/gitlab-com/) use GitLab as a free service
- [GitLab Enterprise Edition](https://about.gitlab.com/gitlab-ee/) with additional features aimed at larger organizations.
- [GitLab CI](https://about.gitlab.com/gitlab-ci/) a continuous integration (CI) server that is easy to integrate with GitLab.
66

67
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
68

69
70
71
72
73
- Ubuntu/Debian/CentOS/RHEL**
- ruby 2.0+
- git 1.7.10+
- redis 2.0+
- MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
74

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

77
## Installation
78

79
Please see [the installation page on the GitLab website](https://about.gitlab.com/installation/) for the various options.
80
Since a manual installation is a lot of work and error prone we strongly recommend the fast and reliable [Omnibus package installation](https://about.gitlab.com/downloads/) (deb/rpm).
81
82
83

## Third-party applications

84
85
There are a lot of applications and API wrappers for GitLab.
Find them [on our website](https://about.gitlab.com/applications/).
86

87
### New versions
88

89
Since 2011 a minor or major version of GitLab is released on the 22nd of every month. Patch and security releases come out when needed.  New features are detailed on the [blog](https://about.gitlab.com/blog/) and in the [changelog](CHANGELOG). For more information about the release process see the release [documentation](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/release). Features that will likely be in the next releases can be found 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).
90

91
### Upgrading
92

93
For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update).
94

95
## Run in production mode
96

97
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:
98

99
    sudo service gitlab start
100

101
or by directly calling the script:
102

103
     sudo /etc/init.d/gitlab start
104

105
Please login with `root` / `5iveL!fe`
dosire's avatar
dosire committed
106

107
## Install a development environment
dosire's avatar
dosire committed
108

109
110
We recommend setting up your development environment with [the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit).
If you do not use the development kit you might need to copy the example development unicorn configuration file
Marin Jankovski's avatar
Marin Jankovski committed
111
112
113

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

114
## Run in development mode
115

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

118
    bundle exec foreman start -p 3000
119

120
or start each component separately:
121

122
    bundle exec rails s
123
    bin/background_jobs start
124

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

127
## Run the tests
128

129
-   Run all tests:
130

131
        bundle exec rake test
132

133
-   [RSpec](http://rspec.info/) unit and functional tests.
134

135
    All RSpec tests: `bundle exec rake spec`
136

137
    Single RSpec file: `bundle exec rspec spec/controllers/commit_controller_spec.rb`
138

139
-   [Spinach](https://github.com/codegram/spinach) integration tests.
140

141
    All Spinach tests: `bundle exec rake spinach`
142

143
    Single Spinach test: `bundle exec spinach features/project/issues/milestones.feature`
144

145
## Documentation
146

147
All documentation can be found on [doc.gitlab.com/ee/](http://doc.gitlab.com/ee/).
148

149
## Getting help
150

151
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
152
153
154
155
156
157
158
159
160

## Is it any good?

[Yes](https://news.ycombinator.com/item?id=3067434)

## Is it awesome?

Thanks for [asking this question](https://twitter.com/supersloth/status/489462789384056832) Joshua.
[These people](https://twitter.com/gitlabhq/favorites) seem to like it.