From 3b19ef5b2654f9adce3e5f44e713dfc0655be121 Mon Sep 17 00:00:00 2001 From: Troy Murray Date: Mon, 29 Jul 2013 09:18:31 -0400 Subject: [PATCH] Clarify documentation on how to add custom Omniauth provider to GitLab --- doc/install/installation.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/doc/install/installation.md b/doc/install/installation.md index c0809b697..e0f542f79 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -361,10 +361,24 @@ GitLab uses [Omniauth](http://www.omniauth.org/) for authentication and already These steps are fairly general and you will need to figure out the exact details from the Omniauth provider's documentation. -* Add `gem "omniauth-your-auth-provider"` to the [Gemfile](https://github.com/gitlabhq/gitlabhq/blob/5-3-stable/Gemfile#L18) -* Run `sudo -u git -H bundle install` to install the new gem(s) +* Stop GitLab + `sudo service gitlab stop` + * Add provider specific configuration options to your `config/gitlab.yml` (you can use the [auth providers section of the example config](https://github.com/gitlabhq/gitlabhq/blob/5-3-stable/config/gitlab.yml.example#L53) as a reference) -* Restart GitLab + +* Add the gem to your [Gemfile](https://github.com/gitlabhq/gitlabhq/blob/5-3-stable/Gemfile#L18) + `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 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` + +> These are the same commands you used in the [Install Gems section](#install-gems) with `--path vendor/bundle --no-deployment` instead of `--deployment`. + +* Start GitLab + `sudo service gitlab start` + ### Examples -- 2.11.0