README.md 5.69 KB
Newer Older
1
2
# GitLab

3
4
5
## Test coverage

- [![Ruby coverage](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage)](https://gitlab-org.gitlab.io/gitlab-ce/coverage-ruby) Ruby
6
- [![JavaScript coverage](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=karma)](https://gitlab-org.gitlab.io/gitlab-ce/coverage-javascript) JavaScript
7

8
9
## Canonical source

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

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

14
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
15

16
17
- Manage Git repositories with fine grained access controls that keep your code secure
- Perform code reviews and enhance collaboration with merge requests
18
19
- 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
20
21
- 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
22

Sid Sijbrandij's avatar
Sid Sijbrandij committed
23
24
25
26
## Hiring

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

27
## Editions
28

Sid Sijbrandij's avatar
Sid Sijbrandij committed
29
There are two editions of GitLab:
30

Sid Sijbrandij's avatar
Sid Sijbrandij committed
31
- GitLab Community Edition (CE) is available freely under the MIT Expat license.
32
- 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/).
33

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
34
35
## Website

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

Morton Fox's avatar
Morton Fox committed
38
- [Subscriptions](https://about.gitlab.com/pricing/)
39
40
41
- [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
42
- [GitLab Enterprise Edition](https://about.gitlab.com/features/#enterprise) with additional features aimed at larger organizations.
43
- [GitLab CI](https://about.gitlab.com/gitlab-ci/) a continuous integration (CI) server that is easy to integrate with GitLab.
44

45
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
46

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

49
## Installation
50

51
52
53
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.
54
55
56

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.

57
58
## Contributing

Ray Paik's avatar
Ray Paik committed
59
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.
60

61
62
63
64
65
66
## Licensing

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

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

Ben Bodenmiller's avatar
Ben Bodenmiller committed
67
All Documentation content that resides under the `doc/` directory of this repository is licensed under Creative Commons: CC BY-SA 4.0.
68

69
70
71
72
73
74
75
76
## 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
77
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).
78
79
80
81
82

## Software stack

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

83
- Ubuntu/Debian/CentOS/RHEL/OpenSUSE
84
- Ruby (MRI) 2.4
85
- Git 2.8.4+
86
- Redis 2.8+
87
- PostgreSQL (preferred) or MySQL
88

89
For more information please see the [architecture documentation](https://docs.gitlab.com/ce/development/architecture.html).
90
91
92

## UX design

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

95
96
## Third-party applications

97
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.
98

99
## GitLab release cycle
100

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

103
## Upgrading
104

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

107
## Documentation
108

109
All documentation can be found on [docs.gitlab.com/ce/](https://docs.gitlab.com/ce/).
110

111
## Getting help
112

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

Andreas Kämmerle 's avatar
Andreas Kämmerle  committed
115
116
117
118
## Why?

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

119
120
121
122
123
124
## Is it any good?

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

## Is it awesome?

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