README.md 5.83 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)

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

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

9
10
11
12
13
14
- 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
15

16
## Canonical source
17

18
- 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/).
19

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

22
- [![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
23

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

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

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

30
- [![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
31

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
32
33
## Website

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

36
37
38
39
40
41
- [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.
42

43
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
44

45
46
47
48
49
- Ubuntu/Debian/CentOS/RHEL**
- ruby 2.0+
- git 1.7.10+
- redis 2.0+
- MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
50

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

53
## Installation
54

55
Please see [the installation page on the GitLab website](https://about.gitlab.com/installation/) for the various options.
56
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).
57
58
59

## Third-party applications

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

63
### New versions
64

65
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).
66

67
### Upgrading
68

69
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).
70

71
## Run in production mode
72

73
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:
74

75
    sudo service gitlab start
76

77
or by directly calling the script:
78

79
     sudo /etc/init.d/gitlab start
80

81
Please login with `root` / `5iveL!fe`
dosire's avatar
dosire committed
82

83
## Install a development environment
dosire's avatar
dosire committed
84

85
86
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
87
88
89

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

90
## Run in development mode
91

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

94
    bundle exec foreman start -p 3000
95

96
or start each component separately:
97

98
    bundle exec rails s
99
    bin/background_jobs start
100

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

103
## Run the tests
104

105
-   Run all tests:
106

107
        bundle exec rake test
108

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

111
    All RSpec tests: `bundle exec rake spec`
112

113
    Single RSpec file: `bundle exec rspec spec/controllers/commit_controller_spec.rb`
114

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

117
    All Spinach tests: `bundle exec rake spinach`
118

119
    Single Spinach test: `bundle exec spinach features/project/issues/milestones.feature`
120

121
## Documentation
122

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

125
## Getting help
126

127
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
128
129
130
131
132
133
134
135
136

## 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.