From 3a3471cc2e4860307740e7f251898abc70646aae Mon Sep 17 00:00:00 2001 From: Sytse Sijbrandij Date: Fri, 5 Dec 2014 13:40:11 +0100 Subject: Update favorites to the new link. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 63fa5e3da86..f303e8e7383 100644 --- a/README.md +++ b/README.md @@ -131,4 +131,4 @@ Please see [Getting help for GitLab](https://about.gitlab.com/getting-help/) on ## Is it awesome? Thanks for [asking this question](https://twitter.com/supersloth/status/489462789384056832) Joshua. -[These people](https://twitter.com/gitlabhq/favorites) seem to like it. +[These people](https://twitter.com/gitlab/favorites) seem to like it. -- cgit v1.2.1 From 98e64610b2b5ad8340d763d3fd370bc11d0ad700 Mon Sep 17 00:00:00 2001 From: Sytse Sijbrandij Date: Wed, 17 Dec 2014 08:27:03 +0100 Subject: Move development information to the GitLab Development Kit. --- README.md | 46 +++------------------------------------------- 1 file changed, 3 insertions(+), 43 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f303e8e7383..abf8331fa8e 100644 --- a/README.md +++ b/README.md @@ -66,55 +66,15 @@ Since 2011 a minor or major version of GitLab is released on the 22nd of every m For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update). -## Run in production mode - -The Installation guide contains instructions on how to download an init script and run it automatically on boot. You can also start the init script manually: - - sudo service gitlab start - -or by directly calling the script: - - sudo /etc/init.d/gitlab start - -Please login with `root` / `5iveL!fe` - ## Install a development environment 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 development kit you might need to copy the example development unicorn configuration file +If you do not use the GitLab Development 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 -## Run in development mode - -Start it with [Foreman](https://github.com/ddollar/foreman) - - bundle exec foreman start -p 3000 - -or start each component separately: - - bundle exec rails s - bin/background_jobs start - -And surf to [localhost:3000](http://localhost:3000/) and login with `root` / `5iveL!fe`. - -## Run the tests - -- Run all tests: - - bundle exec rake test - -- [RSpec](http://rspec.info/) unit and functional tests. - - All RSpec tests: `bundle exec rake spec` - - Single RSpec file: `bundle exec rspec spec/controllers/commit_controller_spec.rb` - -- [Spinach](https://github.com/codegram/spinach) integration tests. - - All Spinach tests: `bundle exec rake spinach` - - Single Spinach test: `bundle exec spinach features/project/issues/milestones.feature` +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). ## Documentation -- cgit v1.2.1 From 3f129fd618bb5f6568ab95c7c7f4450c897bd3c2 Mon Sep 17 00:00:00 2001 From: Sytse Sijbrandij Date: Wed, 17 Dec 2014 11:07:10 +0100 Subject: Include default credentials in the readme and make all headers the same. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index abf8331fa8e..afcaaf0f0fa 100644 --- a/README.md +++ b/README.md @@ -52,17 +52,18 @@ On [about.gitlab.com](https://about.gitlab.com/) you can find more information a Please see [the installation page on the GitLab website](https://about.gitlab.com/installation/) for the various options. Since a manual installation is a lot of work and error prone we strongly recommend the fast and reliable [Omnibus package installation](https://about.gitlab.com/downloads/) (deb/rpm). +You can access new installation with the login `root` and password `5iveL!fe`, after login you are required to set a unique password. ## Third-party applications There are a lot of applications and API wrappers for GitLab. Find them [on our website](https://about.gitlab.com/applications/). -### New versions +## New versions Since 2011 a minor or major version of GitLab is released on the 22nd of every month. Patch and security releases come out 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). -### Upgrading +## Upgrading For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update). -- cgit v1.2.1 From 5b51ef7bdd50e4171e7bdd82e242ac3da35156f7 Mon Sep 17 00:00:00 2001 From: Marc Radulescu Date: Fri, 26 Dec 2014 18:14:23 +0100 Subject: add EE features list and useful links to readme file in gitlab --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index afcaaf0f0fa..07b10875437 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,18 @@ - Completely free and open source (MIT Expat license) - Powered by Ruby on Rails +## Additional features availabe in GitLab Enterprise Edition + +You might be interested in some of the features we include in GitLab Enterprise Edition: + - Deeper LDAP integration, specifically L[DAP group synchronization](http://doc.gitlab.com/ee/integration/ldap.html#ldap-group-synchronization-gitlab-enterprise-edition), sharing a project with other groups, and [multiple LDAP support](http://doc.gitlab.com/ee/integration/ldap.html#integrate-gitlab-with-more-than-one-ldap-server-enterprise-edition); + - Manage contributions to your code with [git hooks](http://doc.gitlab.com/ee/git_hooks/git_hooks.html), [rebasing merge requests](http://doc.gitlab.com/ee/workflow/gitlab_flow.html#do-not-order-commits-with-rebase), and [auditing](http://doc.gitlab.com/ee/administration/audit_events.html); + - [Deeper Jenkins CI integration](http://doc.gitlab.com/ee/integration/jenkins.html); + - [Deeper JIRA integration](http://doc.gitlab.com/ee/integration/jira.html) + +GitLab Enterprise Edition is available to our subscribers, along with support from our side. [How to become a subscriber.](https://about.gitlab.com/pricing/) + +Feel free to check out the rest of the features in GitLab Enterprise Edition [here](https://about.gitlab.com/features/#enterprise) + ## 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. -- cgit v1.2.1 From ce6b0519ccddff2476d2255df49b39ccdb07013e Mon Sep 17 00:00:00 2001 From: Marc Radulescu Date: Mon, 12 Jan 2015 16:47:39 +0100 Subject: remove duplication by linking EE features directly to website --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 07b10875437..ae368ed83ec 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,14 @@ - Completely free and open source (MIT Expat license) - Powered by Ruby on Rails -## Additional features availabe in GitLab Enterprise Edition +## Editions -You might be interested in some of the features we include in GitLab Enterprise Edition: - - Deeper LDAP integration, specifically L[DAP group synchronization](http://doc.gitlab.com/ee/integration/ldap.html#ldap-group-synchronization-gitlab-enterprise-edition), sharing a project with other groups, and [multiple LDAP support](http://doc.gitlab.com/ee/integration/ldap.html#integrate-gitlab-with-more-than-one-ldap-server-enterprise-edition); - - Manage contributions to your code with [git hooks](http://doc.gitlab.com/ee/git_hooks/git_hooks.html), [rebasing merge requests](http://doc.gitlab.com/ee/workflow/gitlab_flow.html#do-not-order-commits-with-rebase), and [auditing](http://doc.gitlab.com/ee/administration/audit_events.html); - - [Deeper Jenkins CI integration](http://doc.gitlab.com/ee/integration/jenkins.html); - - [Deeper JIRA integration](http://doc.gitlab.com/ee/integration/jira.html) +There are two editions available for GitLab. -GitLab Enterprise Edition is available to our subscribers, along with support from our side. [How to become a subscriber.](https://about.gitlab.com/pricing/) +GitLab Community Edition is aimed at individuals and small teams. Click [here](https://about.gitlab.com/features/) for an overview of its major features. -Feel free to check out the rest of the features in GitLab Enterprise Edition [here](https://about.gitlab.com/features/#enterprise) +GitLab Enterprise Edition is designed to accommodate big teams and organizations. You can find out more about the additional features [here](https://about.gitlab.com/features/#compare) +GitLab Enterprise Edition is available to our subscribers, along with support from our side. [How to become a subscriber.](https://about.gitlab.com/pricing/) ## Canonical source -- cgit v1.2.1 From 1cdce0f1828edd806f66999f84de404f24c77dc0 Mon Sep 17 00:00:00 2001 From: Marc Radulescu Date: Tue, 13 Jan 2015 15:47:35 +0100 Subject: revise wording to clarify CE and EE definitions --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ae368ed83ec..a0cf381dd07 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,14 @@ There are two editions available for GitLab. -GitLab Community Edition is aimed at individuals and small teams. Click [here](https://about.gitlab.com/features/) for an overview of its major features. +GitLab Community Edition is an open source code collaboration platform. +Click [here](https://about.gitlab.com/features/) for an overview of its major features. -GitLab Enterprise Edition is designed to accommodate big teams and organizations. You can find out more about the additional features [here](https://about.gitlab.com/features/#compare) -GitLab Enterprise Edition is available to our subscribers, along with support from our side. [How to become a subscriber.](https://about.gitlab.com/pricing/) +GitLab Enterprise Edition includes features useful for organizations with over 100 users. +You can read about these features [here](https://about.gitlab.com/features/#compare) + +GitLab Enterprise Edition is available to GitLab subscribers, along with support from the GitLab B.V. service engineers. +[How to become a subscriber.](https://about.gitlab.com/pricing/) ## Canonical source -- cgit v1.2.1 From 6cce2be7eb742231e60bafd28fb883e0554dbfd0 Mon Sep 17 00:00:00 2001 From: Sytse Sijbrandij Date: Tue, 13 Jan 2015 10:20:04 -0800 Subject: Get rid of here links and simplify text. --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a0cf381dd07..1cdc44a39e1 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,11 @@ ## Editions -There are two editions available for GitLab. +There are two editions of GitLab. +GitLab [Community Edition](https://about.gitlab.com/features/) (CE) is available without any costs under an MIT license. -GitLab Community Edition is an open source code collaboration platform. -Click [here](https://about.gitlab.com/features/) for an overview of its major features. - -GitLab Enterprise Edition includes features useful for organizations with over 100 users. -You can read about these features [here](https://about.gitlab.com/features/#compare) - -GitLab Enterprise Edition is available to GitLab subscribers, along with support from the GitLab B.V. service engineers. -[How to become a subscriber.](https://about.gitlab.com/pricing/) +GitLab Enterprise Edition (EE) includes [extra features](https://about.gitlab.com/features/#compare) that are most useful for organizations with more than 100 users. +To get access to the EE and support please [become a subscriber](https://about.gitlab.com/pricing/). ## Canonical source -- cgit v1.2.1 From 5ade3a6b781413c62df2ce44f6b79ba8ef3c3d62 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Tue, 20 Jan 2015 11:59:35 -0800 Subject: We dont support ruby 2.2 yet --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1cdc44a39e1..393909ef7c0 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ On [about.gitlab.com](https://about.gitlab.com/) you can find more information a ## Requirements - Ubuntu/Debian/CentOS/RHEL** -- ruby 2.0+ +- Ruby (MRI) 2.0 or 2.1 - git 1.7.10+ - redis 2.0+ - MySQL or PostgreSQL -- cgit v1.2.1 From 04b09bdd6793df01ef488a8480be8fce48cb3f09 Mon Sep 17 00:00:00 2001 From: Wolfram Twelker Date: Sun, 8 Feb 2015 00:15:46 +0100 Subject: Revise main README for cleanup and some minor clarifications * Fix typos, add links, add minor text changes * Rephrase three section for clarity [ci skip] --- README.md | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 393909ef7c0..8bfb301d1c7 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,19 @@ - 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) -- Powered by Ruby on Rails +- Powered by [Ruby on Rails](https://github.com/rails/rails) ## Editions There are two editions of GitLab. -GitLab [Community Edition](https://about.gitlab.com/features/) (CE) is available without any costs under an MIT license. +*GitLab [Community Edition](https://about.gitlab.com/features/) (CE)* is available without any costs under an MIT license. -GitLab Enterprise Edition (EE) includes [extra features](https://about.gitlab.com/features/#compare) that are most useful for organizations with more than 100 users. +*GitLab Enterprise Edition (EE)* includes [extra features](https://about.gitlab.com/features/#compare) that are most useful for organizations with more than 100 users. To get access to the EE and support please [become a subscriber](https://about.gitlab.com/pricing/). ## 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. +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. ## Code status @@ -48,42 +48,45 @@ On [about.gitlab.com](https://about.gitlab.com/) you can find more information a ## Requirements -- Ubuntu/Debian/CentOS/RHEL** +GitLab requires the following software: + +- Ubuntu/Debian/CentOS/RHEL - Ruby (MRI) 2.0 or 2.1 -- git 1.7.10+ -- redis 2.0+ +- Git 1.7.10+ +- Redis 2.0+ - MySQL or PostgreSQL -** More details are in the [requirements doc](doc/install/requirements.md). +Please see the [requirements documentation](doc/install/requirements.md) for system requirements and more information about the supported operating systems. ## Installation -Please see [the installation page on the GitLab website](https://about.gitlab.com/installation/) for the various options. -Since a manual installation is a lot of work and error prone we strongly recommend the fast and reliable [Omnibus package installation](https://about.gitlab.com/downloads/) (deb/rpm). -You can access new installation with the login `root` and password `5iveL!fe`, after login you are required to set a unique password. +The recommended way to install GitLab is using the provided [Omnibus packages](https://about.gitlab.com/downloads/). Compared to a manual installation, 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. + +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. ## Third-party applications -There are a lot of applications and API wrappers for GitLab. -Find them [on our website](https://about.gitlab.com/applications/). +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. -## New versions +## GitLab release cycle -Since 2011 a minor or major version of GitLab is released on the 22nd of every month. Patch and security releases come out 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). +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). ## Upgrading -For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update). +For updating the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations 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. ## Install a development environment -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 Development kit you need to install and setup all the dependencies yourself, this is a lot of work and error prone. +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). +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). ## Documentation -- cgit v1.2.1 From 2df8a91c8259711b3fb3d0ab3b31329aae869b96 Mon Sep 17 00:00:00 2001 From: Patricio Cano Date: Mon, 16 Feb 2015 09:10:07 -0800 Subject: Rephrased wording in the documentation to say "installation from source" instead of "manual installation" or similar. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8bfb301d1c7..b4f28a41be3 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ Please see the [requirements documentation](doc/install/requirements.md) for sys ## Installation -The recommended way to install GitLab is using the provided [Omnibus packages](https://about.gitlab.com/downloads/). Compared to a manual installation, 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. +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. 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. @@ -76,7 +76,7 @@ Since 2011 a minor or major version of GitLab is released on the 22nd of every m ## Upgrading -For updating the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations 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. +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. ## Install a development environment -- cgit v1.2.1