README.md 5.21 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
[![coverage report](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage)](https://gitlab.com/gitlab-org/gitlab-ce/commits/master)
5 6
[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)

7 8 9 10
## Canonical source

The source of GitLab Community Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/) and there are mirrors to make [contributing](CONTRIBUTING.md) as easy as possible.

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

13
To see how GitLab looks please see the [features page on our website](https://about.gitlab.com/features/).
14

15 16 17 18 19
- Manage Git repositories with fine grained access controls that keep your code secure
- Perform code reviews and enhance collaboration with merge requests
- Each project can also have an issue tracker and a wiki
- 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)
20
- Powered by [Ruby on Rails](https://github.com/rails/rails)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
21

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
22 23 24 25
## Hiring

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

26
## Editions
27

28
There are two editions of GitLab:
29

30 31
- GitLab Community Edition (CE) is available freely under the MIT Expat license.
- GitLab Enterprise Edition (EE) includes [extra features](https://about.gitlab.com/features/#compare) 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/).
32

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

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

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

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

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

48
## Installation
49

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

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.

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

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
## 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

Instructions on how to start GitLab and how to run the tests can be found in the [development section of the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit#development).

## Software stack

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

- Ubuntu/Debian/CentOS/RHEL
James Lopez's avatar
James Lopez committed
73
- Ruby (MRI) 2.1
74
- Git 2.7.4+
75
- Redis 2.8+
76 77 78 79
- MySQL or PostgreSQL

For more information please see the [architecture documentation](http://doc.gitlab.com/ce/development/architecture.html).

80 81
## Third-party applications

82
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.
83

84
## GitLab release cycle
85

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

88
## Upgrading
89

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

92
## Documentation
93

94
All documentation can be found on [doc.gitlab.com/ce/](http://doc.gitlab.com/ce/).
95

96
## Getting help
97

98
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
99 100 101 102 103 104 105 106

## Is it any good?

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

## Is it awesome?

Thanks for [asking this question](https://twitter.com/supersloth/status/489462789384056832) Joshua.
107
[These people](https://twitter.com/gitlab/favorites) seem to like it.