README.md 6.17 KB
Newer Older
1
2
# GitLab

3
4
![logo](https://about.gitlab.com/images/logo.png)

5
6
## Test coverage

7
- [![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
8
- [![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
9

10
11
## Canonical source

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

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

Sid Sijbrandij's avatar
Sid Sijbrandij committed
16
17
## Free trial

18
You can request a free trial of GitLab Ultimate [on our website](https://about.gitlab.com/free-trial/).
Sid Sijbrandij's avatar
Sid Sijbrandij committed
19

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

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

24
25
- Manage Git repositories with fine grained access controls that keep your code secure
- Perform code reviews and enhance collaboration with merge requests
Mo Khan's avatar
Mo Khan committed
26
- Complete continuous integration (CI) and continuous deployment/delivery (CD) pipelines to build, test, and deploy your applications
27
- Each project can also have an issue tracker, issue board, and a wiki
28
29
- 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
30

31
## Editions
32

Sid Sijbrandij's avatar
Sid Sijbrandij committed
33
There are two editions of GitLab:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
34

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

38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
## Licensing

GitLab Community Edition (CE) is available freely under the MIT Expat license.

All content that resides under the `ee/` directory of this repository (if it exists), is
part of GitLab Enterprise Edition (EE) and is licensed under the license defined
in `ee/LICENSE`.

All third party components incorporated into the GitLab Software are licensed under the original license provided by the owner of the applicable component.

All Documentation content that resides under the `doc/` directory of this repository is licensed under Creative Commons: CC BY-SA 4.0.

## Hiring

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
54
55
## Website

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

Morton Fox's avatar
Morton Fox committed
58
- [Subscriptions](https://about.gitlab.com/pricing/)
59
60
61
- [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
62
- [GitLab Enterprise Edition](https://about.gitlab.com/features/#enterprise) with additional features aimed at larger organizations.
63
- [GitLab CI](https://about.gitlab.com/gitlab-ci/) a continuous integration (CI) server that is easy to integrate with GitLab.
64

65
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
66

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

69
## Installation
70

71
72
73
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.
74
75
76

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.

77
78
## Contributing

Ray Paik's avatar
Ray Paik committed
79
GitLab is an open source project and we are very happy to accept community contributions. Please refer to [Contributing to GitLab page](https://about.gitlab.com/contributing/) for more details.
80

81
82
83
## 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).
84
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.
85
86
87
88
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
89
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).
90
91
92
93
94

## Software stack

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

95
- Ubuntu/Debian/CentOS/RHEL/OpenSUSE
96
- Ruby (MRI) 2.6.3
97
- Git 2.8.4+
98
- Redis 2.8+
99
- PostgreSQL (preferred) or MySQL
100

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

103
104
## UX design

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

107
108
## Third-party applications

109
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.
110

111
## GitLab release cycle
112

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

115
## Upgrading
116

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

119
## Documentation
120

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

123
## Getting help
124

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

Andreas Kämmerle 's avatar
Andreas Kämmerle  committed
127
128
129
130
## Why?

[Read here](https://about.gitlab.com/why/)

131
132
133
134
135
136
## Is it any good?

[Yes](https://news.ycombinator.com/item?id=3067434)

## Is it awesome?

137
[These people](https://twitter.com/gitlab/likes) seem to like it.