README.md 5.33 KB
Newer Older
1
2
# GitLab

3
4
## Canonical source

5
The canonical source of GitLab where development takes place is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab).
6

7
A FOSS source of GitLab is hosted on a [mirrored, read-only project on GitLab.com](https://gitlab.com/gitlab-org/gitlab-foss/).
8

Sid Sijbrandij's avatar
Sid Sijbrandij committed
9
10
## Free trial

11
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
12

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

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

17
18
- 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
19
- Complete continuous integration (CI) and continuous deployment/delivery (CD) pipelines to build, test, and deploy your applications
20
- Each project can also have an issue tracker, issue board, and a wiki
21
22
- 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
23

24
## Editions
25

Sid Sijbrandij's avatar
Sid Sijbrandij committed
26
There are two editions of GitLab:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
27

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

31
32
## Licensing

33
34
See the [LICENSE](LICENSE) file for licensing information as it pertains to
files in this repository.
35
36
37
38
39

## 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
40
41
## Website

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

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

51
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
52

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

55
## Installation
56

57
58
59
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.
60
61
62

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.

63
64
## Contributing

Ray Paik's avatar
Ray Paik committed
65
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.
66

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

## Software stack

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

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

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

89
90
## UX design

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

93
94
## Third-party applications

95
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.
96

97
## GitLab release cycle
98

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

101
## Upgrading
102

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

105
## Documentation
106

Robert Speicher's avatar
Robert Speicher committed
107
All documentation can be found on <https://docs.gitlab.com>.
108

109
## Getting help
110

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

Andreas Kämmerle 's avatar
Andreas Kämmerle  committed
113
114
115
116
## Why?

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

117
118
119
120
121
122
## Is it any good?

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

## Is it awesome?

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