README.md 7.4 KB
Newer Older
1
2
# GitLab

3
4
[![Build status](https://gitlab.com/gitlab-org/gitlab-ee/badges/master/build.svg)](https://gitlab.com/gitlab-org/gitlab-ee/commits/master)
[![Overall test coverage](https://gitlab.com/gitlab-org/gitlab-ee/badges/master/coverage.svg)](https://gitlab.com/gitlab-org/gitlab-ee/pipelines)
5
[![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.svg)](https://gemnasium.com/gitlabhq/gitlabhq)
6
[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
7
[![Core Infrastructure Initiative Best Practices](https://bestpractices.coreinfrastructure.org/projects/42/badge)](https://bestpractices.coreinfrastructure.org/projects/42)
8
[![Gitter](https://badges.gitter.im/gitlabhq/gitlabhq.svg)](https://gitter.im/gitlabhq/gitlabhq?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
9

10
11
## Test coverage

12
- [![Ruby coverage](https://gitlab.com/gitlab-org/gitlab-ee/badges/master/coverage.svg?job=coverage)](https://gitlab-org.gitlab.io/gitlab-ee/coverage-ruby) Ruby
13
- [![JavaScript coverage](https://gitlab.com/gitlab-org/gitlab-ee/badges/master/coverage.svg?job=karma)](https://gitlab-org.gitlab.io/gitlab-ee/coverage-javascript) JavaScript
14

15
16
## Canonical source

Sean McGivern's avatar
Sean McGivern committed
17
The canonical source of GitLab Community Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/).
18

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

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

Sid Sijbrandij's avatar
Sid Sijbrandij committed
23
24
25
26
## Free trial

You can request a free trial of GitLab Enterprise Edition [on our website](https://about.gitlab.com/free-trial/).

27
28
29
30
## Subscriber onboarding information

Thank you for purchasing a GitLab subscription!

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

Job van der Voort's avatar
Job van der Voort committed
33
34
GitLab Enterprise Edition repository:
https://gitlab.com/gitlab-com/gitlab-ee
35

Job van der Voort's avatar
Job van der Voort committed
36
Download GitLab Enterprise Edition:
Sid Sijbrandij's avatar
Sid Sijbrandij committed
37
https://about.gitlab.com/downloads-ee
38
39
40
41

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

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

45
If you need help with your GitLab installation and for any technical questions please see the [support page](https://about.gitlab.com/support/)
46

47
For all other questions, please see our [contact page](https://about.gitlab.com/contact/)
48

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

51
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
52

53
54
- Manage Git repositories with fine grained access controls that keep your code secure
- Perform code reviews and enhance collaboration with merge requests
55
56
- Complete continuous integration (CI) and CD pipelines to builds, test, and deploy your applications
- Each project can also have an issue tracker, issue board, and a wiki
57
58
- 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)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
59

Sid Sijbrandij's avatar
Sid Sijbrandij committed
60
61
62
63
## Hiring

We're hiring developers, support people, and production engineers all the time, please see our [jobs page](https://about.gitlab.com/jobs/).

64
## Editions
65

Sid Sijbrandij's avatar
Sid Sijbrandij committed
66
There are two editions of GitLab:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
67

Sid Sijbrandij's avatar
Sid Sijbrandij committed
68
- GitLab Community Edition (CE) is available freely under the MIT Expat license.
69
- GitLab Enterprise Edition (EE) includes [extra features](https://about.gitlab.com/products/#compare-options) 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/products/).
70

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
71
72
## Website

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

Morton Fox's avatar
Morton Fox committed
75
- [Subscriptions](https://about.gitlab.com/pricing/)
76
77
78
- [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
Morton Fox's avatar
Morton Fox committed
79
- [GitLab Enterprise Edition](https://about.gitlab.com/features/#enterprise) with additional features aimed at larger organizations.
80
- [GitLab CI](https://about.gitlab.com/gitlab-ci/) a continuous integration (CI) server that is easy to integrate with GitLab.
81

82
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
83

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

86
## Installation
87

88
89
90
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.
91
92
93

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.

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

96
97
98
99
## Contributing

GitLab is an open source project and we are very happy to accept community contributions. Please refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for details.

100
101
102
103
104
105
106
107
## 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

dixpac's avatar
dixpac committed
108
Instructions on how to start GitLab and how to run the tests can be found in the [getting started section of the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit#getting-started).
109
110
111
112
113

## Software stack

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

114
- Ubuntu/Debian/CentOS/RHEL/OpenSUSE
115
- Ruby (MRI) 2.3
116
- Git 2.8.4+
117
- Redis 2.8+
118
- PostgreSQL (preferred) or MySQL
119

120
For more information please see the [architecture documentation](https://docs.gitlab.com/ce/development/architecture.html).
121

122
123
## UX design

124
Please adhere to the [UX Guide](doc/development/ux_guide/index.md) when creating designs and implementing code.
125

126
127
## Third-party applications

128
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.
129

130
## GitLab release cycle
131

132
For more information about the release process see the [release documentation](https://gitlab.com/gitlab-org/release-tools/blob/master/README.md).
133

134
## Upgrading
135

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

138
## Documentation
139

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

142
## Getting help
143

144
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
145
146
147
148
149
150
151
152

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