gitlab-org--gitlab-foss/doc/install/requirements.md

# Requirements

## Operating Systems

GitLab is developed for the Linux operating system. For the installations options and instructions please see [the installation section of the readme](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/README.md#installation).

### Supported Linux distributions

- Ubuntu
- Debian
- CentOS
- RedHat Enterprise Linux
- Scientific Linux
- Oracle Linux

### Unsupported Linux distributions

- Arch Linux
- Fedora
- Gentoo

But on the above unsupported distributions is still possible to install GitLab yourself with the [manual installation guide](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md).

### Unsupported Unix operating systems

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 do this, please be aware it could be a lot of work.

Please consider using a virtual machine to run GitLab.

### Other operating systems such as Windows

GitLab does **not** run on Windows and we have no plans of supporting it in the near future.

Please consider using a virtual machine to run GitLab.

## Ruby versions

GitLab requires Ruby (MRI) 2.0 or 2.1

You will have to use the standard MRI implementation of Ruby.

We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/)) but GitLab needs several Gems that have native extensions.

## Hardware requirements

### CPU

- 1 core works supports up to 100 users but the application will not be responsive
- **2 cores** is the **recommended** number of cores and supports up to 500 users
- 4 cores supports up to 2,000 users
- 8 cores supports up to 5,000 users
- 16 cores supports up to 10,000 users
- 32 cores supports up to 20,000 users
- 64 cores supports up to 40,000 users

### Memory

- 512MB is the absolute minimum but we do not recommend this amount of memory.
You will either need to configure a minimum swap of 256MB and this will only allow you to run one slow unicorn worker.
One unicorn worker will cause only git ssh access to work because the git http access requires two running workers.
It requires one worker to receive the user request and one worker for the authorization check.
Or if you use SSD you can configure 2GB of swap to use two Unicorn workers and have slow operation with http access.
- 1GB supports up to 100 users (with individual repositories under 250MB, otherwise git memory usage necessitates configuring swap space)
- **2GB** is the **recommended** memory size and supports up to 500 users
- 4GB supports up to 2,000 users
- 8GB supports up to 5,000 users
- 16GB supports up to 10,000 users
- 32GB supports up to 20,000 users
- 64GB supports up to 40,000 users

### Storage

The necessary hard drive space largely depends on the size of the repos you want to store in GitLab. But as a *rule of thumb* you should have at least twice as much free space as your all repos combined take up. You need twice the storage because [GitLab satellites](structure.md) contain an extra copy of each repo.

If you want to be flexible about growing your hard drive space in the future consider mounting it using LVM so you can add more hard drives when you need them.

Apart from a local hard drive you can also mount a volume that supports the network file system (NFS) protocol. This volume might be located on a file server, a network attached storage (NAS) device, a storage area network (SAN) or on an Amazon Web Services (AWS) Elastic Block Store (EBS) volume.

If you have enough RAM memory and a recent CPU the speed of GitLab is mainly limited by hard drive seek times. Having a fast drive (7200 RPM and up) or a solid state drive (SSD) will improve the responsiveness of GitLab.

## Database

If you want to run the database separately, the **recommended** database size is **1 MB per user**.

## Redis and Sidekiq

Redis stores all user sessions and the background task queue.
The storage requirements for Redis are minimal, about 1kB per user.
Sidekiq processes the background jobs with a multithreaded process.
This process starts with the entire Rails stack (200MB+) but it can grow over time due to memory leaks.
On a very active server (10.000 active users) the Sidekiq process can use 1GB+ of memory.

## Supported webbrowsers

- Chrome (Latest stable version)
- Firefox (Latest released version) 
- Safari 7+ (known problem: required fields in html5 do not work)
- Opera (Latest released version)
- IE 10+
Add titles to doc pages. 2014-05-27 12:12:15 +00:00			`# Requirements`

			`## Operating Systems`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00
Remove duplication and link to CentOS guide. 2014-02-05 08:26:46 +00:00			`GitLab is developed for the Linux operating system. For the installations options and instructions please see [the installation section of the readme](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/README.md#installation).`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`### Supported Linux distributions`
Decouple requirements and install 2012-10-25 08:13:11 +00:00
Add enterprise linux distributions as officially supported. 2014-03-07 15:35:59 +00:00			`- Ubuntu`
			`- Debian`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00			`- CentOS`
Add enterprise linux distributions as officially supported. 2014-03-07 15:35:59 +00:00			`- RedHat Enterprise Linux`
			`- Scientific Linux`
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00			`- Oracle Linux`

Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`### Unsupported Linux distributions`
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00
			`- Arch Linux`
Decouple requirements and install 2012-10-25 08:13:11 +00:00			`- Fedora`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00			`- Gentoo`
Decouple requirements and install 2012-10-25 08:13:11 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`But on the above unsupported distributions is still possible to install GitLab yourself with the [manual installation guide](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md).`
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`### Unsupported Unix operating systems`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00			`There is nothing that prevents GitLab from running on other Unix operating systems.`
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00			`This means you may get it to work on systems running FreeBSD or OS X.`
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00			`If you want to do this, please be aware it could be a lot of work.`
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00			`Please consider using a virtual machine to run GitLab.`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`### Other operating systems such as Windows`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00
Ensure customers know that GitLab.com supports RHEL. 2013-11-21 18:38:05 +00:00			`GitLab does not run on Windows and we have no plans of supporting it in the near future.`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`Please consider using a virtual machine to run GitLab.`
Update hardware and platform requirements guide 2012-12-05 18:31:08 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`## Ruby versions`
Decouple requirements and install 2012-10-25 08:13:11 +00:00
Support Ruby 2.1 and better explain the memory requirements. 2014-06-05 06:45:12 +00:00			`GitLab requires Ruby (MRI) 2.0 or 2.1`
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00
Nobody uses GitLab with Jruby. 2014-01-25 16:57:18 +00:00			`You will have to use the standard MRI implementation of Ruby.`
Decouple requirements and install 2012-10-25 08:13:11 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/)) but GitLab needs several Gems that have native extensions.`
Decouple requirements and install 2012-10-25 08:13:11 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`## Hardware requirements`
Better header and detail why you need two times the storage. Also moving memory and storage to the bottom, OS is more important. 2013-03-24 10:02:39 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`### CPU`
Better header and detail why you need two times the storage. Also moving memory and storage to the bottom, OS is more important. 2013-03-24 10:02:39 +00:00
Take into account active users. 2014-04-21 10:34:08 +00:00			`- 1 core works supports up to 100 users but the application will not be responsive`
			`- 2 cores is the recommended number of cores and supports up to 500 users`
			`- 4 cores supports up to 2,000 users`
			`- 8 cores supports up to 5,000 users`
Too many zeros in CPU req listing There were too many zeros in the listing of users for CPU's. 2014-05-28 17:08:00 +00:00			`- 16 cores supports up to 10,000 users`
			`- 32 cores supports up to 20,000 users`
			`- 64 cores supports up to 40,000 users`
Better header and detail why you need two times the storage. Also moving memory and storage to the bottom, OS is more important. 2013-03-24 10:02:39 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`### Memory`
Better header and detail why you need two times the storage. Also moving memory and storage to the bottom, OS is more important. 2013-03-24 10:02:39 +00:00
People report that 2GB of swap on Digital Ocean also does the trick. 2014-06-19 06:22:58 +00:00			`- 512MB is the absolute minimum but we do not recommend this amount of memory.`
			`You will either need to configure a minimum swap of 256MB and this will only allow you to run one slow unicorn worker.`
			`One unicorn worker will cause only git ssh access to work because the git http access requires two running workers.`
			`It requires one worker to receive the user request and one worker for the authorization check.`
			`Or if you use SSD you can configure 2GB of swap to use two Unicorn workers and have slow operation with http access.`
Support Ruby 2.1 and better explain the memory requirements. 2014-06-05 06:45:12 +00:00			`- 1GB supports up to 100 users (with individual repositories under 250MB, otherwise git memory usage necessitates configuring swap space)`
Take into account active users. 2014-04-21 10:34:08 +00:00			`- 2GB is the recommended memory size and supports up to 500 users`
			`- 4GB supports up to 2,000 users`
			`- 8GB supports up to 5,000 users`
			`- 16GB supports up to 10,000 users`
			`- 32GB supports up to 20,000 users`
			`- 64GB supports up to 40,000 users`
Updating based on Dmitriy his comments. 2013-03-24 21:23:28 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`### Storage`
Updating based on Dmitriy his comments. 2013-03-24 21:23:28 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`The necessary hard drive space largely depends on the size of the repos you want to store in GitLab. But as a rule of thumb you should have at least twice as much free space as your all repos combined take up. You need twice the storage because [GitLab satellites](structure.md) contain an extra copy of each repo.`
Better header and detail why you need two times the storage. Also moving memory and storage to the bottom, OS is more important. 2013-03-24 10:02:39 +00:00
Better requirements based on the experience of GitLab Cloud. 2013-10-04 10:20:40 +00:00			`If you want to be flexible about growing your hard drive space in the future consider mounting it using LVM so you can add more hard drives when you need them.`

			`Apart from a local hard drive you can also mount a volume that supports the network file system (NFS) protocol. This volume might be located on a file server, a network attached storage (NAS) device, a storage area network (SAN) or on an Amazon Web Services (AWS) Elastic Block Store (EBS) volume.`
Updating based on Dmitriy his comments. 2013-03-24 21:23:28 +00:00
Better requirements based on the experience of GitLab Cloud. 2013-10-04 10:20:40 +00:00			`If you have enough RAM memory and a recent CPU the speed of GitLab is mainly limited by hard drive seek times. Having a fast drive (7200 RPM and up) or a solid state drive (SSD) will improve the responsiveness of GitLab.`
Decouple requirements and install 2012-10-25 08:13:11 +00:00
added database requirements in documentation 2014-05-05 08:04:52 +00:00			`## Database`

Some background on Redis and Sidekiq requirements. 2014-06-24 08:29:50 +00:00			`If you want to run the database separately, the recommended database size is 1 MB per user.`

			`## Redis and Sidekiq`

			`Redis stores all user sessions and the background task queue.`
			`The storage requirements for Redis are minimal, about 1kB per user.`
			`Sidekiq processes the background jobs with a multithreaded process.`
			`This process starts with the entire Rails stack (200MB+) but it can grow over time due to memory leaks.`
			`On a very active server (10.000 active users) the Sidekiq process can use 1GB+ of memory.`
Added webbrowser requirements Fixes https://github.com/gitlabhq/gitlabhq/issues/4319 2014-01-14 16:47:12 +00:00
Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`## Supported webbrowsers`
Added webbrowser requirements Fixes https://github.com/gitlabhq/gitlabhq/issues/4319 2014-01-14 16:47:12 +00:00
			`- Chrome (Latest stable version)`
			`- Firefox (Latest released version)`
Fix typo 2014-05-11 13:23:51 +00:00			`- Safari 7+ (known problem: required fields in html5 do not work)`
Added webbrowser requirements Fixes https://github.com/gitlabhq/gitlabhq/issues/4319 2014-01-14 16:47:12 +00:00			`- Opera (Latest released version)`
Correct a wrong spelling "abolute" -> "absolute" 2014-05-14 14:06:52 +00:00			`- IE 10+`