Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 105 lines (62 sloc) 6.065 kb
f4872fc @dosire Make source code on GitLab more prominent.
dosire authored
1 ## Canonical source
2
3 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.
4
47b9ac6 @dosire Fix images on GitHub and link to the about url.
dosire authored
5 # ![logo](https://about.gitlab.com/images/gitlab_logo.png) GitLab
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
6
89ed1e0 @dosire Clean up the readme.
dosire authored
7 ## Open source software to collaborate on code
33cd1ae @randx Update README
randx authored
8
47b9ac6 @dosire Fix images on GitHub and link to the about url.
dosire authored
9 ![Animated screenshots](https://about.gitlab.com/images/animated/compiled.gif)
862fbb6 @dosire Add animated screenshots.
dosire authored
10
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
11 - Manage Git repositories with fine grained access controls that keep your code secure
12 - Perform code reviews and enhance collaboration with merge requests
13 - Each project can also have an issue tracker and a wiki
14 - Used by more than 100,000 organizations, GitLab is the most popular solution to manage Git repositories on-premises
15 - Completely free and open source (MIT Expat license)
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
16 - Powered by [Ruby on Rails](https://github.com/rails/rails)
2c71c2e @randx trying new readme
randx authored
17
ce6b051 remove duplication by linking EE features directly to website
Marc Radulescu authored
18 ## Editions
5b51ef7 add EE features list and useful links to readme file in gitlab
Marc Radulescu authored
19
6cce2be @dosire Get rid of here links and simplify text.
dosire authored
20 There are two editions of GitLab.
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
21 *GitLab [Community Edition](https://about.gitlab.com/features/) (CE)* is available without any costs under an MIT license.
5b51ef7 add EE features list and useful links to readme file in gitlab
Marc Radulescu authored
22
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
23 *GitLab Enterprise Edition (EE)* includes [extra features](https://about.gitlab.com/features/#compare) that are most useful for organizations with more than 100 users.
6cce2be @dosire Get rid of here links and simplify text.
dosire authored
24 To get access to the EE and support please [become a subscriber](https://about.gitlab.com/pricing/).
5b51ef7 add EE features list and useful links to readme file in gitlab
Marc Radulescu authored
25
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
26 ## Code status
9104535 @NARKOZ brand new README
NARKOZ authored
27
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
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)
9104535 @NARKOZ brand new README
NARKOZ authored
29
56b08c7 @randx Semaphoreapp badge
randx authored
30 - [![Build Status](https://semaphoreapp.com/api/v1/projects/2f1a5809-418b-4cc2-a1f4-819607579fe7/243338/badge.png)](https://semaphoreapp.com/gitlabhq/gitlabhq)
31
02ee3a5 @PeterDaveHello Use svg instead of png to get better image quality
PeterDaveHello authored
32 - [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
737a449 @dosire Cleaned up and enhanced readme.
dosire authored
33
8b1da50 @randx Update coveralls badge
randx authored
34 - [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq?branch=master)
269a985 @randx fixed travis env, added coverage badge
randx authored
35
89ed1e0 @dosire Clean up the readme.
dosire authored
36 ## Website
37
47b9ac6 @dosire Fix images on GitHub and link to the about url.
dosire authored
38 On [about.gitlab.com](https://about.gitlab.com/) you can find more information about:
9104535 @NARKOZ brand new README
NARKOZ authored
39
47b9ac6 @dosire Fix images on GitHub and link to the about url.
dosire authored
40 - [Subscriptions](https://about.gitlab.com/subscription/)
41 - [Consultancy](https://about.gitlab.com/consultancy/)
42 - [Community](https://about.gitlab.com/community/)
43 - [Hosted GitLab.com](https://about.gitlab.com/gitlab-com/) use GitLab as a free service
44 - [GitLab Enterprise Edition](https://about.gitlab.com/gitlab-ee/) with additional features aimed at larger organizations.
45 - [GitLab CI](https://about.gitlab.com/gitlab-ci/) a continuous integration (CI) server that is easy to integrate with GitLab.
737a449 @dosire Cleaned up and enhanced readme.
dosire authored
46
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
47 ## Requirements
9104535 @NARKOZ brand new README
NARKOZ authored
48
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
49 GitLab requires the following software:
50
51 - Ubuntu/Debian/CentOS/RHEL
5ade3a6 @randx We dont support ruby 2.2 yet
randx authored
52 - Ruby (MRI) 2.0 or 2.1
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
53 - Git 1.7.10+
54 - Redis 2.0+
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
55 - MySQL or PostgreSQL
9104535 @NARKOZ brand new README
NARKOZ authored
56
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
57 Please see the [requirements documentation](doc/install/requirements.md) for system requirements and more information about the supported operating systems.
737a449 @dosire Cleaned up and enhanced readme.
dosire authored
58
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
59 ## Installation
ee4dd77 @dosire Installation should be a paragraph since it is deep linked from everywhe...
dosire authored
60
2df8a91 @supernova32 Rephrased wording in the documentation to say "installation from source"...
supernova32 authored
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.
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
62
63 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.
64
65 You can access a new installation with the login **`root`** and password **`5iveL!fe`**, after login you are required to set a unique password.
6614957 @dosire Move third party below the installation section and hint at the Omnibus ...
dosire authored
66
67 ## Third-party applications
68
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
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.
0d56b1b @dosire Updated links to gitlab.com and added the last doc files.
dosire authored
70
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
71 ## GitLab release cycle
d8eefdc @dosire Removing duplication by putting everything in the readme. Allow us to cl...
dosire authored
72
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
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).
d8eefdc @dosire Removing duplication by putting everything in the readme. Allow us to cl...
dosire authored
74
3f129fd @dosire Include default credentials in the readme and make all headers the same.
dosire authored
75 ## Upgrading
d8eefdc @dosire Removing duplication by putting everything in the readme. Allow us to cl...
dosire authored
76
2df8a91 @supernova32 Rephrased wording in the documentation to say "installation from source"...
supernova32 authored
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.
d8eefdc @dosire Removing duplication by putting everything in the readme. Allow us to cl...
dosire authored
78
4ea7b19 @dosire Use same size headers. Add PullReview. Mention shell guide as created by...
dosire authored
79 ## Install a development environment
d97d811 @dosire List the next steps.
dosire authored
80
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
81 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).
82 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.
98e6461 @dosire Move development information to the GitLab Development Kit.
dosire authored
83 One small thing you also have to do when installing it yourself is to copy the example development unicorn configuration file:
4df1a10 @maxlazio Update development steps.
maxlazio authored
84
85 cp config/unicorn.rb.example.development config/unicorn.rb
86
04b09bd @wtw Revise main README for cleanup and some minor clarifications
wtw authored
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).
737a449 @dosire Cleaned up and enhanced readme.
dosire authored
88
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
89 ## Documentation
737a449 @dosire Cleaned up and enhanced readme.
dosire authored
90
2303356 @dosire Link to doc site from the readme.
dosire authored
91 All documentation can be found on [doc.gitlab.com/ce/](http://doc.gitlab.com/ce/).
56d1cc5 @dosire Replacing the development guide.
dosire authored
92
fd348de @cirosantilli Update docs to markdown style guide.
cirosantilli authored
93 ## Getting help
56d1cc5 @dosire Replacing the development guide.
dosire authored
94
47b9ac6 @dosire Fix images on GitHub and link to the about url.
dosire authored
95 Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on our website for the many options to get help.
c300788 @dosire Ensure the readme answers the most important questions.
dosire authored
96
97 ## Is it any good?
98
99 [Yes](https://news.ycombinator.com/item?id=3067434)
100
101 ## Is it awesome?
102
103 Thanks for [asking this question](https://twitter.com/supersloth/status/489462789384056832) Joshua.
3a3471c @dosire Update favorites to the new link.
dosire authored
104 [These people](https://twitter.com/gitlab/favorites) seem to like it.
Something went wrong with that request. Please try again.