README.md 5.92 KB
Newer Older
1
# ![logo](https://about.gitlab.com/images/gitlab_logo.png) GitLab
2

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

5
![Animated screenshots](https://about.gitlab.com/images/animated/compiled.gif)
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
6

7 8 9 10 11
- 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)
12
- Powered by [Ruby on Rails](https://github.com/rails/rails)
Dmytro Zaporozhets's avatar
Dmytro Zaporozhets committed
13

14
## Editions
15

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

19
*GitLab Enterprise Edition (EE)* includes [extra features](https://about.gitlab.com/features/#compare) that are most useful for organizations with more than 100 users.
20
To get access to the EE and support please [become a subscriber](https://about.gitlab.com/pricing/).
21

22
## Canonical source
23

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

26
## Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
27

28
- [![build status](https://ci.gitlab.org/projects/1/status.png?ref=master)](https://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch)
Nihad Abbasov's avatar
Nihad Abbasov committed
29

Dmytro Zaporozhets's avatar
Dmytro Zaporozhets committed
30 31
- [![Build Status](https://semaphoreapp.com/api/v1/projects/2f1a5809-418b-4cc2-a1f4-819607579fe7/243338/badge.png)](https://semaphoreapp.com/gitlabhq/gitlabhq)

32
- [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
33

Dmytro Zaporozhets's avatar
Dmytro Zaporozhets committed
34
- [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq?branch=master)
35

Sid Sijbrandij's avatar
Sid Sijbrandij committed
36 37
## Website

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

40 41 42 43 44 45
- [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.
46

47
## Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
48

49 50 51
GitLab requires the following software:

- Ubuntu/Debian/CentOS/RHEL
52
- Ruby (MRI) 2.0 or 2.1
53 54
- Git 1.7.10+
- Redis 2.0+
55
- MySQL or PostgreSQL
Nihad Abbasov's avatar
Nihad Abbasov committed
56

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

59
## Installation
60

61
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.
62 63 64 65

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.

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

## Third-party applications

69
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.
70

71
## GitLab release cycle
72

73
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).
74

75
## Upgrading
76

77
For updating the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For installations from source there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update) detailing all necessary commands to migrate to the next version.
78

79
## Install a development environment
Sid Sijbrandij's avatar
Sid Sijbrandij committed
80

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

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

87
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).
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.