README.md 5.49 KB
Newer Older
1
2
# GitLab

André Luís's avatar
André Luís committed
3
4
Just a change.

André Luís's avatar
André Luís committed
5
6
And another.

André Luís's avatar
André Luís committed
7
8
And yet another!!

9
10
## Canonical source

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

13
If you wish to clone a copy of GitLab without proprietary code, you can use the read-only mirror of GitLab located at https://gitlab.com/gitlab-org/gitlab-foss/. Please do not submit any issues and/or merge requests to this project.
14

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

17
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
18

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

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

23
24
- 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
25
- Complete continuous integration (CI) and continuous deployment/delivery (CD) pipelines to build, test, and deploy your applications
26
- Each project can also have an issue tracker, issue board, and a wiki
27
28
- 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
29

30
## Editions
31

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

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

37
38
## Licensing

39
40
See the [LICENSE](LICENSE) file for licensing information as it pertains to
files in this repository.
41
42
43
44
45

## 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
46
47
## Website

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

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

57
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
58

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

61
## Installation
62

63
64
65
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.
66
67
68

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.

69
70
## Contributing

Ray Paik's avatar
Ray Paik committed
71
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.
72

73
74
75
## 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).
76
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.
77
78
79
80
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
81
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).
82
83
84
85
86

## Software stack

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

87
- Ubuntu/Debian/CentOS/RHEL/OpenSUSE
88
- Ruby (MRI) 2.6.3
89
- Git 2.8.4+
90
- Redis 2.8+
91
- PostgreSQL (preferred) or MySQL
92

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

95
96
## UX design

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

99
100
## Third-party applications

101
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.
102

103
## GitLab release cycle
104

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

107
## Upgrading
108

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

111
## Documentation
112

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

115
## Getting help
116

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

Andreas Kämmerle 's avatar
Andreas Kämmerle  committed
119
120
121
122
## Why?

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

123
124
125
126
127
128
## Is it any good?

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

## Is it awesome?

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