README.md 5.2 KB
Newer Older
1 2
# GitLab

Takuya Noguchi's avatar
Takuya Noguchi committed
3
[![build status](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/build.svg)](https://gitlab.com/gitlab-org/gitlab-ce/commits/master)
4
[![Build Status](https://semaphoreci.com/api/v1/projects/2f1a5809-418b-4cc2-a1f4-819607579fe7/400484/shields_badge.svg)](https://semaphoreci.com/gitlabhq/gitlabhq)
5
[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
6
[![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.svg?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq?branch=master)
7

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

Sid Sijbrandij's avatar
Sid Sijbrandij committed
25
There are two editions of GitLab:
26

Sid Sijbrandij's avatar
Sid Sijbrandij committed
27 28
- 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/).
29

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

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

34 35 36 37 38 39
- [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.
40

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

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

45
## Installation
46

47 48 49
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.
50 51 52

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.

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

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
## 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
70
- Ruby (MRI) 2.1
71
- Git 2.7.4+
72
- Redis 2.8+
73 74 75 76
- MySQL or PostgreSQL

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

77 78
## Third-party applications

79
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.
80

81
## GitLab release cycle
82

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

85
## Upgrading
86

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

89
## Documentation
90

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

93
## Getting help
94

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

## 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.
104
[These people](https://twitter.com/gitlab/favorites) seem to like it.