README.md 6.46 KB
Newer Older
1 2
# GitLab

3
[![Build status](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/build.svg)](https://gitlab.com/gitlab-org/gitlab-ce/commits/master)
4
[![Overall test coverage](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg)](https://gitlab.com/gitlab-org/gitlab-ce/pipelines)
5
[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
6
[![Core Infrastructure Initiative Best Practices](https://bestpractices.coreinfrastructure.org/projects/42/badge)](https://bestpractices.coreinfrastructure.org/projects/42)
7
[![Gitter](https://badges.gitter.im/gitlabhq/gitlabhq.svg)](https://gitter.im/gitlabhq/gitlabhq?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
8

9 10 11
## 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
12
- [![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
13

14 15
## Canonical source

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

Sid Sijbrandij's avatar
Sid Sijbrandij committed
18
## Open source software to collaborate on code
Dmytro Zaporozhets's avatar
Dmytro Zaporozhets committed
19

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

22 23
- Manage Git repositories with fine grained access controls that keep your code secure
- Perform code reviews and enhance collaboration with merge requests
24 25
- 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
26 27
- 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)
Dmytro Zaporozhets's avatar
Dmytro Zaporozhets committed
28

Sid Sijbrandij's avatar
Sid Sijbrandij committed
29 30 31 32
## Hiring

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

33
## Editions
34

Sid Sijbrandij's avatar
Sid Sijbrandij committed
35
There are two editions of GitLab:
36

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

Sid Sijbrandij's avatar
Sid 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

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
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
You can access a new installation with the login **`root`** and password **`5iveL!fe`**, after login you are required to set a unique password.
64

65 66 67 68
## Contributing

GitLab is an open source project and we are very happy to accept community contributions. Please refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for details.

69 70 71 72 73 74
## 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.

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

77 78 79 80 81 82 83 84
## 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

85
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).
86 87 88 89 90

## Software stack

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

91
- Ubuntu/Debian/CentOS/RHEL/OpenSUSE
92
- Ruby (MRI) 2.3
93
- Git 2.8.4+
94
- Redis 2.8+
95
- PostgreSQL (preferred) or MySQL
96

97
For more information please see the [architecture documentation](https://docs.gitlab.com/ce/development/architecture.html).
98 99 100

## UX design

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

103 104
## Third-party applications

105
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.
106

107
## GitLab release cycle
108

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

111
## Upgrading
112

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

115
## Documentation
116

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

119
## Getting help
120

121
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
122 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.
130