README.md 6.94 KB
Newer Older
1
2
# GitLab

3
4
## Test coverage

5
- [![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
6
- [![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
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

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

14
# ![logo](https://about.gitlab.com/images/gitlab_logo.png) GitLab
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

20
21
22
23
## Subscriber onboarding information

Thank you for purchasing a GitLab subscription!

24
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).
25

Job van der Voort's avatar
Job van der Voort committed
26
27
GitLab Enterprise Edition repository:
https://gitlab.com/gitlab-com/gitlab-ee
28

Job van der Voort's avatar
Job van der Voort committed
29
Download GitLab Enterprise Edition:
Sid Sijbrandij's avatar
Sid Sijbrandij committed
30
https://about.gitlab.com/downloads-ee
31
32
33
34

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

Sid Sijbrandij's avatar
Sid Sijbrandij committed
35
To upgrade from CE, just perform a normal upgrade, but use an EE package:
36
https://about.gitlab.com/upgrade/
37

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

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

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

44
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
45

46
47
- Manage Git repositories with fine grained access controls that keep your code secure
- Perform code reviews and enhance collaboration with merge requests
48
49
- 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
50
51
- 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
52

Sid Sijbrandij's avatar
Sid Sijbrandij committed
53
54
55
56
## Hiring

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

57
## Editions
58

Sid Sijbrandij's avatar
Sid Sijbrandij committed
59
There are two editions of GitLab:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
60

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

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
64
65
## Website

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

Morton Fox's avatar
Morton Fox committed
68
- [Subscriptions](https://about.gitlab.com/pricing/)
69
70
71
- [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
72
- [GitLab Enterprise Edition](https://about.gitlab.com/features/#enterprise) with additional features aimed at larger organizations.
73
- [GitLab CI](https://about.gitlab.com/gitlab-ci/) a continuous integration (CI) server that is easy to integrate with GitLab.
74

75
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
76

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

79
## Installation
80

81
82
83
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.
84
85
86

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.

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

89
90
## Contributing

Ray Paik's avatar
Ray Paik committed
91
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.
92

93
94
95
96
97
98
## 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
99
All Documentation content that resides under the `doc/` directory of this repository is licensed under Creative Commons: CC BY-SA 4.0.
100

101
102
103
## 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).
104
If you do not use the GitLab Development Kit you need to install and set up all the dependencies yourself, this is a lot of work and error prone.
105
106
107
108
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
109
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).
110
111
112
113
114

## Software stack

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

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

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

123
124
## UX design

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

127
128
## Third-party applications

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

131
## GitLab release cycle
132

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

135
## Upgrading
136

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

139
## Documentation
140

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

143
## Getting help
144

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

Andreas Kämmerle 's avatar
Andreas Kämmerle  committed
147
148
149
150
## Why?

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

151
152
153
154
155
156
## Is it any good?

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

## Is it awesome?

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