From 198e93ccf2b880d9dba52240dc8759b930b4ebf3 Mon Sep 17 00:00:00 2001 From: Riyad Preukschas Date: Wed, 5 Dec 2012 19:31:08 +0100 Subject: [PATCH] Update hardware and platform requirements guide --- doc/install/installation.md | 5 ++-- doc/install/requirements.md | 52 ++++++++++++++++++++++++++++--------- 2 files changed, 43 insertions(+), 14 deletions(-) diff --git a/doc/install/installation.md b/doc/install/installation.md index 09a47a19324..f531baf9744 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -1,6 +1,7 @@ -_This installation guide created for Debian/Ubuntu and properly tested._ +This installation guide was created for Debian/Ubuntu and tested on it. + +Please read doc/install/requirements.md for hardware andplatform requirements. -_Checkout requirements before setup_ ### IMPORTANT diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 75b02d6456f..ec5b013c5d8 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -1,28 +1,56 @@ -## Platform requirements: +# Hardware -**The project is designed for the Linux operating system.** +We recommend you to run GitLab on a server with at least 1GB RAM. -It may work on FreeBSD and Mac OS, but we don't test our application for these systems and can't guarantee stability and full functionality. +The necessary hard disk space largely depends on the size of the repos you want +to use GitLab with. But as a *rule of thumb* you should have at least as much +free space as your all repos combined take up. -We officially support (recent versions of) these Linux distributions: + + +# Operating Systems + +## Linux + +GitLab is developed for the Linux operating system. + +GitLab officially supports (recent versions of) these Linux distributions: - Ubuntu Linux - Debian/GNU Linux -It should work on: +It should also work on (though they are not officially supported): +- Arch +- CentOS - Fedora -- CentOs +- Gentoo - RedHat -You might have some luck using these, but no guarantees: +## Other Unix Systems -- FreeBSD will likely work, see https://github.com/gitlabhq/gitlabhq/issues/796 -- MacOS X will likely work, see https://groups.google.com/forum/#!topic/gitlabhq/5IXHbPkjKLA +There is nothing that prevents GitLab from running on other Unix operating +systems. This means you may get it to work on systems running FreeBSD or OS X. +**If you want to try, please proceed with caution!** -GitLab does **not** run on Windows and we have no plans of making GitLab compatible. +## Windows + +GitLab does **not** run on Windows and we have no plans of supporting it in the +near future. -## Hardware: -We recommend to use server with at least 1GB RAM for gitlab instance. +# Rubies + +GitLab requires Ruby (MRI) 1.9.3 and several Gems with native components. +While it is generally possible to use other Rubies (like +[JRuby](http://jruby.org/) or [Rubinius](http://rubini.us/)) it might require +some work on your part. + + + +# Installation troubles and reporting success or failure + +If you have troubles installing GitLab following the official installation guide +or want to share your experience installing GitLab on a not officially supported +platform, please follow the the contribution guide (see CONTRIBUTING.md).