Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCiro Santilli <ciro.santilli@gmail.com>2014-04-25 02:48:22 +0400
committerCiro Santilli <ciro.santilli@gmail.com>2014-06-04 01:16:31 +0400
commitfd348de76d651d49acc8eb742cc647dc777ef5fc (patch)
tree26f42bef57c9a636eff0a548a29cb1e2e6d12c8c /doc/install
parentde1a7aa7eb523cf2fdad12f8eeda2ba4c5b51820 (diff)
Update docs to markdown style guide.
Diffstat (limited to 'doc/install')
-rw-r--r--doc/install/README.md10
-rw-r--r--doc/install/installation.md171
-rw-r--r--doc/install/requirements.md35
3 files changed, 95 insertions, 121 deletions
diff --git a/doc/install/README.md b/doc/install/README.md
index ec80e3cd62a..239f5f301ec 100644
--- a/doc/install/README.md
+++ b/doc/install/README.md
@@ -1,4 +1,6 @@
-+ [Installation](installation.md)
-+ [Requirements](requirements.md)
-+ [Structure](structure.md)
-+ [Database MySQL](database_mysql.md)
+# Installation
+
+- [Installation](installation.md)
+- [Requirements](requirements.md)
+- [Structure](structure.md)
+- [Database MySQL](database_mysql.md)
diff --git a/doc/install/installation.md b/doc/install/installation.md
index 0dc28d8da82..866032fb7c9 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -1,14 +1,14 @@
# Installation
-# Select Version to Install
-Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install. In most cases
-this should be the highest numbered stable branch (example shown below).
+## Select Version to Install
+
+Make sure you view [this installation guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md) from the branch (version) of GitLab you would like to install. In most cases this should be the highest numbered stable branch (example shown below).
![capture](http://i.imgur.com/d2AlIVj.png)
If the highest number stable branch is unclear please check the [GitLab Blog](https://www.gitlab.com/blog/) for installation guide links by version.
-# Important notes
+## Important notes
This guide is long because it covers many cases and includes all commands you need, this is [one of the few installation scripts that actually works out of the box](https://twitter.com/robinvdvleuten/status/424163226532986880).
@@ -20,21 +20,18 @@ The following steps have been known to work. Please **use caution when you devia
If you find a bug/error in this guide please **submit a merge request** following the [contributing guide](../../CONTRIBUTING.md).
-- - -
-
-# Overview
+## Overview
The GitLab installation consists of setting up the following components:
1. Packages / Dependencies
-2. Ruby
-3. System Users
-4. Database
-5. GitLab
-6. Nginx
-
+1. Ruby
+1. System Users
+1. Database
+1. GitLab
+1. Nginx
-# 1. Packages / Dependencies
+## 1. Packages / Dependencies
`sudo` is not installed on Debian by default. Make sure your system is
up-to-date and install it.
@@ -44,10 +41,7 @@ up-to-date and install it.
apt-get upgrade -y
apt-get install sudo -y
-**Note:**
-During this installation some files will need to be edited manually.
-If you are familiar with vim set it as default editor with the commands below.
-If you are not familiar with vim please skip this and keep using the default editor.
+**Note:** During this installation some files will need to be edited manually. If you are familiar with vim set it as default editor with the commands below. If you are not familiar with vim please skip this and keep using the default editor.
# Install vim and set as default editor
sudo apt-get install -y vim
@@ -84,15 +78,13 @@ Is the system packaged Git too old? Remove it and compile from source.
# When editing config/gitlab.yml (Step 6), change the git bin_path to /usr/local/bin/git
-**Note:** In order to receive mail notifications, make sure to install a
-mail server. By default, Debian is shipped with exim4 whereas Ubuntu
-does not ship with one. The recommended mail server is postfix and you can install it with:
+**Note:** In order to receive mail notifications, make sure to install a mail server. By default, Debian is shipped with exim4 whereas Ubuntu does not ship with one. The recommended mail server is postfix and you can install it with:
sudo apt-get install -y postfix
Then select 'Internet Site' and press enter to confirm the hostname.
-# 2. Ruby
+## 2. Ruby
The use of ruby version managers such as [RVM](http://rvm.io/), [rbenv](https://github.com/sstephenson/rbenv) or [chruby](https://github.com/postmodern/chruby) with GitLab in production frequently leads to hard to diagnose problems. For example, GitLab Shell is called from OpenSSH and having a version manager can prevent pushing and pulling over SSH. Version managers are not supported and we stronly advise everyone to follow the instructions below to use a system ruby.
@@ -113,17 +105,15 @@ Install the Bundler Gem:
sudo gem install bundler --no-ri --no-rdoc
-
-# 3. System Users
+## 3. System Users
Create a `git` user for Gitlab:
sudo adduser --disabled-login --gecos 'GitLab' git
-# 4. Database
+## 4. Database
-We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](database_mysql.md).
-NOTE: because we need to make use of extensions you need at least pgsql 9.1.
+We recommend using a PostgreSQL database. For MySQL check [MySQL setup guide](database_mysql.md). *Note*: because we need to make use of extensions you need at least pgsql 9.1.
# Install the database packages
sudo apt-get install -y postgresql-9.1 postgresql-client libpq-dev
@@ -143,13 +133,12 @@ NOTE: because we need to make use of extensions you need at least pgsql 9.1.
# Try connecting to the new database with the new user
sudo -u git -H psql -d gitlabhq_production
-
-# 5. GitLab
+## 5. GitLab
# We'll install GitLab into home directory of the user "git"
cd /home/git
-## Clone the Source
+### Clone the Source
# Clone GitLab repository
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-ce.git -b 6-9-stable gitlab
@@ -157,10 +146,9 @@ NOTE: because we need to make use of extensions you need at least pgsql 9.1.
# Go to gitlab dir
cd /home/git/gitlab
-**Note:**
-You can change `6-9-stable` to `master` if you want the *bleeding edge* version, but never install master on a production server!
+**Note:** You can change `6-9-stable` to `master` if you want the *bleeding edge* version, but never install master on a production server!
-## Configure it
+### Configure it
cd /home/git/gitlab
@@ -206,10 +194,9 @@ You can change `6-9-stable` to `master` if you want the *bleeding edge* version,
sudo -u git -H git config --global user.email "example@example.com"
sudo -u git -H git config --global core.autocrlf input
-**Important Note:**
-Make sure to edit both `gitlab.yml` and `unicorn.rb` to match your setup.
+**Important Note:** Make sure to edit both `gitlab.yml` and `unicorn.rb` to match your setup.
-## Configure GitLab DB settings
+### Configure GitLab DB settings
# PostgreSQL only:
sudo -u git cp config/database.yml.postgresql config/database.yml
@@ -229,14 +216,9 @@ Make sure to edit both `gitlab.yml` and `unicorn.rb` to match your setup.
# Make config/database.yml readable to git only
sudo -u git -H chmod o-rwx config/database.yml
-## Install Gems
+### Install Gems
-**Note:** As of bundler 1.5.2, you can invoke `bundle install -jN`
-(where `N` the number of your processor cores) and enjoy the parallel gems installation with measurable
-difference in completion time (~60% faster). Check the number of your cores with `nproc`.
-For more information check this [post](http://robots.thoughtbot.com/parallel-gem-installing-using-bundler).
-First make sure you have bundler >= 1.5.2 (run `bundle -v`) as it addresses some [issues](https://devcenter.heroku.com/changelog-items/411)
-that were [fixed](https://github.com/bundler/bundler/pull/2817) in 1.5.2.
+**Note:** As of bundler 1.5.2, you can invoke `bundle install -jN` (where `N` the number of your processor cores) and enjoy the parallel gems installation with measurable difference in completion time (~60% faster). Check the number of your cores with `nproc`. For more information check this [post](http://robots.thoughtbot.com/parallel-gem-installing-using-bundler). First make sure you have bundler >= 1.5.2 (run `bundle -v`) as it addresses some [issues](https://devcenter.heroku.com/changelog-items/411) that were [fixed](https://github.com/bundler/bundler/pull/2817) in 1.5.2.
cd /home/git/gitlab
@@ -246,7 +228,7 @@ that were [fixed](https://github.com/bundler/bundler/pull/2817) in 1.5.2.
# Or if you use MySQL (note, the option says "without ... postgres")
sudo -u git -H bundle install --deployment --without development test postgres aws
-## Install GitLab shell
+### Install GitLab shell
GitLab Shell is an ssh access and repository management software developed specially for GitLab.
@@ -259,8 +241,7 @@ GitLab Shell is an ssh access and repository management software developed speci
# By default, the gitlab-shell config is generated from your main gitlab config. You can review (and modify) it as follows:
sudo -u git -H editor /home/git/gitlab-shell/config.yml
-
-## Initialize Database and Activate Advanced Features
+### Initialize Database and Activate Advanced Features
sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production
@@ -268,7 +249,7 @@ GitLab Shell is an ssh access and repository management software developed speci
# When done you see 'Administrator account created:'
-## Install Init Script
+### Install Init Script
Download the init script (will be /etc/init.d/gitlab):
@@ -284,37 +265,34 @@ Make GitLab start on boot:
sudo update-rc.d gitlab defaults 21
-## Set up logrotate
+### Set up logrotate
sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab
-## Check Application Status
+### Check Application Status
Check if GitLab and its environment are configured correctly:
sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
-## Compile assets
+### Compile assets
sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production
-## Start Your GitLab Instance
+### Start Your GitLab Instance
sudo service gitlab start
# or
sudo /etc/init.d/gitlab restart
+## 6. Nginx
-# 6. Nginx
-
-**Note:**
-Nginx is the officially supported web server for GitLab. If you cannot or do not want to use Nginx as your web server, have a look at the
-[GitLab recipes](https://gitlab.com/gitlab-org/gitlab-recipes/).
+**Note:** Nginx is the officially supported web server for GitLab. If you cannot or do not want to use Nginx as your web server, have a look at the [GitLab recipes](https://gitlab.com/gitlab-org/gitlab-recipes/).
-## Installation
+### Installation
sudo apt-get install -y nginx
-## Site Configuration
+### Site Configuration
Download an example site config:
@@ -327,14 +305,13 @@ Make sure to edit the config file to match your setup:
# domain name of your host serving GitLab.
sudo editor /etc/nginx/sites-available/gitlab
-## Restart
+### Restart
sudo service nginx restart
+## Done!
-# Done!
-
-## Double-check Application Status
+### Double-check Application Status
To make sure you didn't miss anything run a more thorough check with:
@@ -342,51 +319,38 @@ To make sure you didn't miss anything run a more thorough check with:
If all items are green, then congratulations on successfully installing GitLab!
-## Initial Login
+### Initial Login
-Visit YOUR_SERVER in your web browser for your first GitLab login.
-The setup has created an admin account for you. You can use it to log in:
+Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has created an admin account for you. You can use it to log in:
root
5iveL!fe
-**Important Note:**
-Please go over to your profile page and immediately change the password, so
-nobody can access your GitLab by using this login information later on.
+**Important Note:** Please go over to your profile page and immediately change the password, so nobody can access your GitLab by using this login information later on.
**Enjoy!**
+## Advanced Setup Tips
-- - -
-
+### Additional markup styles
-# Advanced Setup Tips
-
-## Additional markup styles
-
-Apart from the always supported markdown style there are other rich text files that GitLab can display.
-But you might have to install a dependency to do so.
-Please see the [github-markup gem readme](https://github.com/gitlabhq/markup#markups) for more information.
-For example, reStructuredText markup language support requires python-docutils:
+Apart from the always supported markdown style there are other rich text files that GitLab can display. But you might have to install a dependency to do so. Please see the [github-markup gem readme](https://github.com/gitlabhq/markup#markups) for more information. For example, reStructuredText markup language support requires python-docutils:
sudo apt-get install -y python-docutils
-## Custom Redis Connection
+### Custom Redis Connection
-If you'd like Resque to connect to a Redis server on a non-standard port or on
-a different host, you can configure its connection string via the
-`config/resque.yml` file.
+If you'd like Resque to connect to a Redis server on a non-standard port or on a different host, you can configure its connection string via the `config/resque.yml` file.
# example
production: redis://redis.example.tld:6379
-If you want to connect the Redis server via socket, then use the "unix:" URL scheme
-and the path to the Redis socket file in the `config/resque.yml` file.
+If you want to connect the Redis server via socket, then use the "unix:" URL scheme and the path to the Redis socket file in the `config/resque.yml` file.
# example
production: unix:/path/to/redis/socket
-## Custom SSH Connection
+### Custom SSH Connection
If you are running SSH on a non-standard port, you must change the gitlab user's SSH config.
@@ -398,39 +362,44 @@ If you are running SSH on a non-standard port, you must change the gitlab user's
You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the `config\gitlab.yml` file.
-## LDAP authentication
+### LDAP authentication
You can configure LDAP authentication in config/gitlab.yml. Please restart GitLab after editing this file.
-## Using Custom Omniauth Providers
+### Using Custom Omniauth Providers
GitLab uses [Omniauth](http://www.omniauth.org/) for authentication and already ships with a few providers preinstalled (e.g. LDAP, GitHub, Twitter). But sometimes that is not enough and you need to integrate with other authentication solutions. For these cases you can use the Omniauth provider.
-### Steps
+#### Steps
These steps are fairly general and you will need to figure out the exact details from the Omniauth provider's documentation.
-* Stop GitLab
- `sudo service gitlab stop`
+- Stop GitLab:
+
+ sudo service gitlab stop
+
+- Add the gem to your [Gemfile](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/Gemfile):
-* Add provider specific configuration options to your `config/gitlab.yml` (you can use the [auth providers section of the example config](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example) as a reference)
+ gem "omniauth-your-auth-provider"
-* Add the gem to your [Gemfile](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/Gemfile)
- `gem "omniauth-your-auth-provider"`
-* If you're using MySQL, install the new Omniauth provider gem by running the following command:
- `sudo -u git -H bundle install --without development test postgres --path vendor/bundle --no-deployment`
+- If you're using MySQL, install the new Omniauth provider gem by running the following command:
-* If you're using PostgreSQL, install the new Omniauth provider gem by running the following command:
- `sudo -u git -H bundle install --without development test mysql --path vendor/bundle --no-deployment`
+ sudo -u git -H bundle install --without development test postgres --path vendor/bundle --no-deployment
-> These are the same commands you used in the [Install Gems section](#install-gems) with `--path vendor/bundle --no-deployment` instead of `--deployment`.
+- If you're using PostgreSQL, install the new Omniauth provider gem by running the following command:
-* Start GitLab
- `sudo service gitlab start`
+ sudo -u git -H bundle install --without development test mysql --path vendor/bundle --no-deployment
+ > These are the same commands you used in the [Install Gems section](#install-gems) with `--path vendor/bundle --no-deployment` instead of `--deployment`.
-### Examples
+- Start GitLab:
+
+ `sudo service gitlab start`
+
+#### Examples
If you have successfully set up a provider that is not shipped with GitLab itself, please let us know.
+
You can help others by reporting successful configurations and probably share a few insights or provide warnings for common errors or pitfalls by sharing your experience [in the public Wiki](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations).
+
While we can't officially support every possible auth mechanism out there, we'd like to at least help those with special needs.
diff --git a/doc/install/requirements.md b/doc/install/requirements.md
index f8d2a423c08..cec35ca7be7 100644
--- a/doc/install/requirements.md
+++ b/doc/install/requirements.md
@@ -4,7 +4,7 @@
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
+### Supported Linux distributions
- Ubuntu
- Debian
@@ -13,37 +13,42 @@ GitLab is developed for the Linux operating system. For the installations option
- Scientific Linux
- Oracle Linux
-## Unsupported Linux distributions
+### Unsupported Linux distributions
- Arch Linux
- Fedora
- Gentoo
-But on the above unsupported distributions is stll possible to install GitLab yourself with the [manual installation guide](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md).
+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
+### 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
+### 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.
+Please consider using a virtual machine to run GitLab.
-# Ruby versions
+## Ruby versions
GitLab requires Ruby (MRI) 2.0+.
+
+>>>>>>> Update docs to markdown style guide.
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.
+We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/)) but GitLab needs several Gems that have native extensions.
-# Hardware requirements
+## Hardware requirements
-## CPU
+### 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
@@ -53,7 +58,7 @@ We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/)) but GitLab
- 32 cores supports up to 20,000 users
- 64 cores supports up to 40,000 users
-## Memory
+### Memory
- 512MB is the absolute minimum, you need 256MB of swap, you can configure only one slow unicorn worker, only ssh access will work, we do not recommend this
- 1GB supports up to 100 users (with individual repositories under 250MB, otherwise git memory usage necessitates using swap space)
@@ -64,11 +69,9 @@ We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/)) but GitLab
- 32GB supports up to 20,000 users
- 64GB supports up to 40,000 users
-## Storage
+### 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.
+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.
@@ -80,7 +83,7 @@ If you have enough RAM memory and a recent CPU the speed of GitLab is mainly lim
If you want to run the database separately, the **recommended** database size is **1 MB per user**
-# Supported webbrowsers
+## Supported webbrowsers
- Chrome (Latest stable version)
- Firefox (Latest released version)