Clarify documentation on how to add custom Omniauth provider to GitLab

Troy Murray
1 parent 1a83fea7
Showing 1 changed file with 17 additions and 3 deletions Show diff stats
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
...	...	@@ -361,10 +361,24 @@ GitLab uses [Omniauth](http://www.omniauth.org/) for authentication and already
361	361
362	362	These steps are fairly general and you will need to figure out the exact details from the Omniauth provider's documentation.
363	363
364		-* Add `gem "omniauth-your-auth-provider"` to the [Gemfile](https://github.com/gitlabhq/gitlabhq/blob/5-3-stable/Gemfile#L18)
365		-* Run `sudo -u git -H bundle install` to install the new gem(s)
	364	+* Stop GitLab
	365	+ `sudo service gitlab stop`
	366	+
366	367	* 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)
367		-* Restart GitLab
	368	+
	369	+* Add the gem to your [Gemfile](https://github.com/gitlabhq/gitlabhq/blob/5-3-stable/Gemfile#L18)
	370	+ `gem "omniauth-your-auth-provider"`
	371	+* If you're using MySQL, install the new Omniauth provider gem by running the following command:
	372	+ `sudo -u git -H bundle install --without development test postgres --path vendor/bundle --no-deployment`
	373	+
	374	+* If you're using PostgreSQL, install the new Omniauth provider gem by running the following command:
	375	+ `sudo -u git -H bundle install --without development test mysql --path vendor/bundle --no-deployment`
	376	+
	377	+> These are the same commands you used in the [Install Gems section](#install-gems) with `--path vendor/bundle --no-deployment` instead of `--deployment`.
	378	+
	379	+* Start GitLab
	380	+ `sudo service gitlab start`
	381	+
368	382
369	383	### Examples
370	384
...	...