README.md 6.09 KB
Newer Older
1
2
# GitLab

3
[![build status](https://ci.gitlab.com/projects/1/status.svg?ref=master)](https://ci.gitlab.com/projects/1?ref=master)
4
[![Build Status](https://semaphoreci.com/api/v1/projects/2f1a5809-418b-4cc2-a1f4-819607579fe7/400484/shields_badge.svg)](https://semaphoreci.com/gitlabhq/gitlabhq)
5
[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
6
[![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.svg?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq?branch=master)
7

8
9
10
11
## Canonical source

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.

Sid Sijbrandij's avatar
Sid Sijbrandij committed
12
The source of GitLab Enterprise Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ee).
13

14
# ![logo](https://about.gitlab.com/images/gitlab_logo.png) GitLab
15

16
17
18
19
## Subscriber onboarding information

Thank you for purchasing a GitLab subscription!

20
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).
21

Job van der Voort's avatar
Job van der Voort committed
22
23
GitLab Enterprise Edition repository:
https://gitlab.com/gitlab-com/gitlab-ee
24

Job van der Voort's avatar
Job van der Voort committed
25
Download GitLab Enterprise Edition:
Sid Sijbrandij's avatar
Sid Sijbrandij committed
26
https://about.gitlab.com/downloads-ee
27
28
29
30

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

Sid Sijbrandij's avatar
Sid Sijbrandij committed
31
32
To upgrade from CE, just perform a normal upgrade, but use an EE package:
https://about.gitlab.com/update/#ee
33

Sid Sijbrandij's avatar
Sid Sijbrandij committed
34
If you need help with your GitLab installation and for any technical questions please contact us at subscribers@gitlab.com
35

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

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

40
To see how GitLab looks please see the [features page on our website](https://about.gitlab.com/features/).
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
41

42
43
44
45
46
- 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)
47
- Powered by [Ruby on Rails](https://github.com/rails/rails)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
48

49
## Editions
50

Sid Sijbrandij's avatar
Sid Sijbrandij committed
51
There are two editions of GitLab:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
52

Sid Sijbrandij's avatar
Sid Sijbrandij committed
53
54
- GitLab Community Edition (CE) is available freely under the MIT Expat license.
- GitLab Enterprise Edition (EE) includes [extra features](https://about.gitlab.com/features/#compare) that are more useful for organizations with more than 100 users. To use EE and get official support please [become a subscriber](https://about.gitlab.com/pricing/).
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
Please see the [requirements documentation](doc/install/requirements.md) for system requirements and more information about the supported operating systems.
70

71
## Installation
72

73
74
75
The recommended way to install GitLab is with the [Omnibus packages](https://about.gitlab.com/downloads/) on our package server.
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.
76
77
78

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.

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

81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
## Install a development environment

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.
One small thing you also have to do when installing it yourself is to copy the example development unicorn configuration file:

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

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

## Software stack

GitLab is a Ruby on Rails application that runs on the following software:

- Ubuntu/Debian/CentOS/RHEL
96
- Ruby (MRI) 2.1
97
- Git 1.7.10+
98
- Redis 2.8+
99
100
101
- MySQL or PostgreSQL

For more information please see the [architecture documentation](http://doc.gitlab.com/ce/development/architecture.html).
102
103
104

## Third-party applications

105
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.
106

107
## GitLab release cycle
108

109
For more information about the release process see the [release documentation](http://doc.gitlab.com/ce/release/).
110

111
## Upgrading
112

Sid Sijbrandij's avatar
Sid Sijbrandij committed
113
For upgrading information please see our [update page](https://about.gitlab.com/update/).
114

115
## Documentation
116

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

119
## Getting help
120

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

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