This instance will be upgraded to Heptapod 0.31.0 (final) on 2022-05-24 at 14:00 UTC+2 (a few minutes of down time)

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

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

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

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

14
## Editions
15

16
There are two editions available for GitLab. 
17

18
19
GitLab Community Edition is an open source code collaboration platform.
Click [here](https://about.gitlab.com/features/) for an overview of its major features.
20

21
22
23
24
25
GitLab Enterprise Edition includes features useful for organizations with over 100 users.
You can read about these features [here](https://about.gitlab.com/features/#compare)

GitLab Enterprise Edition is available to GitLab subscribers, along with support from the GitLab B.V. service engineers.
[How to become a subscriber.](https://about.gitlab.com/pricing/)
26

27
## Canonical source
28

29
- The source of GitLab Community Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/) and there are mirrors to make [contributing](CONTRIBUTING.md) as easy as possible.
30

31
## Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
32

33
- [![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
34

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

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

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

41
- [![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
42

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
43
44
## Website

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

47
48
49
50
51
52
- [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.
53

54
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
55

56
57
58
59
60
- Ubuntu/Debian/CentOS/RHEL**
- ruby 2.0+
- git 1.7.10+
- redis 2.0+
- MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
61

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

64
## Installation
65

66
Please see [the installation page on the GitLab website](https://about.gitlab.com/installation/) for the various options.
67
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).
68
You can access new installation with the login `root` and password `5iveL!fe`, after login you are required to set a unique password.
69
70
71

## Third-party applications

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

75
## New versions
76

77
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).
78

79
## Upgrading
80

81
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).
82

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

85
We recommend setting up your development environment with [the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit).
86
87
If you do not use the GitLab Development Development kit you need to install and setup all the dependencies yourself, this is a lot of work and error prone.
One small thing you also have to do when installing it yourself is to copy the example development unicorn configuration file:
Marin Jankovski's avatar
Marin Jankovski committed
88
89
90

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

91
Instructions on how to start Gitlab and how to run the tests can be found in the [development section of the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit#development).
92

93
## Documentation
94

dosire's avatar
dosire committed
95
All documentation can be found on [doc.gitlab.com/ce/](http://doc.gitlab.com/ce/).
96

97
## Getting help
98

99
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
100
101
102
103
104
105
106
107

## 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.
108
[These people](https://twitter.com/gitlab/favorites) seem to like it.