README.md 5.59 KB
Newer Older
1 2 3 4 5 6 7
# GitLab

[![build status](https://ci.gitlab.com/projects/1/status.png?ref=master)](https://ci.gitlab.com/projects/1?ref=master)
[![Build Status](https://semaphoreapp.com/api/v1/projects/2f1a5809-418b-4cc2-a1f4-819607579fe7/243338/badge.png)](https://semaphoreapp.com/gitlabhq/gitlabhq)
[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
[![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq?branch=master)

8 9 10 11
## 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.

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

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

16 17 18 19 20
- 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)
21
- Powered by [Ruby on Rails](https://github.com/rails/rails)
Dmytro Zaporozhets's avatar
Dmytro Zaporozhets committed
22

23
## Editions
24

25
There are two editions of GitLab.
26
*GitLab [Community Edition](https://about.gitlab.com/features/) (CE)* is available without any costs under an MIT license.
27

28
*GitLab Enterprise Edition (EE)* includes [extra features](https://about.gitlab.com/features/#compare) that are most useful for organizations with more than 100 users.
29
To use EE and get official support please [become a subscriber](https://about.gitlab.com/pricing/).
30

Sid Sijbrandij's avatar
Sid Sijbrandij committed
31 32
## Website

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

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

42
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
43

44 45 46
GitLab requires the following software:

- Ubuntu/Debian/CentOS/RHEL
47
- Ruby (MRI) 2.0 or 2.1
48 49
- Git 1.7.10+
- Redis 2.0+
50
- MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
51

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

54
## Installation
55

56
The recommended way to install GitLab is using the provided [Omnibus packages](https://about.gitlab.com/downloads/). 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.
57 58 59

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.

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

## Third-party applications

64
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.
65

66
## GitLab release cycle
67

68
Since 2011 a minor or major version of GitLab is released on the 22nd of every month. Patch and security releases are published when needed. New features are detailed on the [blog](https://about.gitlab.com/blog/) and in the [changelog](CHANGELOG). For more information about the release process see the [release documentation](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/release). Features that will likely be in the next releases can be found on the [feature request forum](http://feedback.gitlab.com/forums/176466-general) with the status [started](http://feedback.gitlab.com/forums/176466-general/status/796456) and [completed](http://feedback.gitlab.com/forums/176466-general/status/796457).
69

70
## Upgrading
71

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

74
## Install a development environment
Sid Sijbrandij's avatar
Sid Sijbrandij committed
75

76 77
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.
78
One small thing you also have to do when installing it yourself is to copy the example development unicorn configuration file:
Marin Jankovski's avatar
Marin Jankovski committed
79 80 81

    cp config/unicorn.rb.example.development config/unicorn.rb

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

84
## Documentation
85

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

88
## Getting help
89

90
Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
91 92 93 94 95 96 97 98

## 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.
Sid Sijbrandij's avatar
Sid Sijbrandij committed
99
[These people](https://twitter.com/gitlab/favorites) seem to like it.