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

3
4
5
6
## Subscriber onboarding information

Thank you for purchasing a GitLab subscription!

7
For standard subscribers, please see **emergency contact info and other useful information** in [the Standard subscribers README](https://gitlab.com/standard/standard-subscriber-information/tree/master#README).
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

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.

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

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

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

31
32
33
34
35
- 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)
36
- Powered by [Ruby on Rails](https://github.com/rails/rails)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
37

38
## Editions
39

40
There are two editions of GitLab.
41
*GitLab [Community Edition](https://about.gitlab.com/features/) (CE)* is available without any costs under an MIT license.
42

43
*GitLab Enterprise Edition (EE)* includes [extra features](https://about.gitlab.com/features/#compare) that are most useful for organizations with more than 100 users.
44
To get access to the EE and support please [become a subscriber](https://about.gitlab.com/pricing/).
45

46
## Canonical source
47

48
- 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/).
49

50
## Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
51

52
- [![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
53

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

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

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
60
61
## Website

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

64
65
66
67
68
69
- [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.
70

71
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
72

73
74
75
GitLab requires the following software:

- Ubuntu/Debian/CentOS/RHEL
76
- Ruby (MRI) 2.0 or 2.1
77
78
- Git 1.7.10+
- Redis 2.0+
79
- MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
80

81
Please see the [requirements documentation](doc/install/requirements.md) for system requirements and more information about the supported operating systems.
82

83
## Installation
84

85
The recommended way to install GitLab is using the provided [Omnibus packages](https://about.gitlab.com/downloads/). Compared to an installation from source, this is faster and less error prone. Just select your operating system, download the respective package (Debian or RPM) and install it using the system's package manager.
86
87
88
89

There are various other options to install GitLab, please refer to the [installation page on the GitLab website](https://about.gitlab.com/installation/) for more information.

You can access a new installation with the login **`root`** and password **`5iveL!fe`**, after login you are required to set a unique password.
90
91
92

## Third-party applications

93
There are a lot of [third-party applications integrating with GitLab](https://about.gitlab.com/applications/). These include GUI Git clients, mobile applications and API wrappers for various languages.
94

95
## GitLab release cycle
96

97
Since 2011 a minor or major version of GitLab is released on the 22nd of every month. Patch and security releases are published 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).
98

99
## Upgrading
100

101
For updating the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For installations from source there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update) detailing all necessary commands to migrate to the next version.
102

103
## Install a development environment
dosire's avatar
dosire committed
104

105
106
To work on GitLab itself, 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 GitLab Development Kit you need to install and setup all the dependencies yourself, this is a lot of work and error prone.
107
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
108
109
110

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

111
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).
112

113
## Documentation
114

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

117
## Getting help
118

119
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
120
121
122
123
124
125
126
127

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