Adding special cases to the advanced setup notes.

Sytse Sijbrandij
1 parent 84652388
Showing 1 changed file with 24 additions and 0 deletions Show diff stats
doc/install/installation.md
@@ -292,3 +292,27 @@ If you are running SSH on a non-standard port, you must change the gitlab user&#39;s
         hostname 127.0.0.1; # Your server name or IP
  
 You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the `config\gitlab.yml` file.
+
+## LDAP authentication
+
+You can configure LDAP authentication in config/gitlab.yml. Please restart GitLab after editing this file.
+
+## 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
+
+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/master/Gemfile#L18)
+* Run `sudo -u gitlab -H bundle install` to install the new gem(s)
+* 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/master/config/gitlab.yml.example#L53) as a reference)
+* Add icons for the new provider into the [vendor/assets/images/authbuttons](https://github.com/gitlabhq/gitlabhq/tree/master/vendor/assets/images/authbuttons) directory (you can find some more popular ones over at https://github.com/intridea/authbuttons)
+* Restart GitLab
+
+### 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/Working-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.
...	...	@@ -292,3 +292,27 @@ If you are running SSH on a non-standard port, you must change the gitlab user's
292	292	hostname 127.0.0.1; # Your server name or IP
293	293
294	294	You also need to change the corresponding options (e.g. ssh_user, ssh_host, admin_uri) in the `config\gitlab.yml` file.
	295	+
	296	+## LDAP authentication
	297	+
	298	+You can configure LDAP authentication in config/gitlab.yml. Please restart GitLab after editing this file.
	299	+
	300	+## Using Custom Omniauth Providers
	301	+
	302	+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.
	303	+
	304	+### Steps
	305	+
	306	+These steps are fairly general and you will need to figure out the exact details from the Omniauth provider's documentation.
	307	+
	308	+* Add `gem "omniauth-your-auth-provider"` to the [Gemfile](https://github.com/gitlabhq/gitlabhq/blob/master/Gemfile#L18)
	309	+* Run `sudo -u gitlab -H bundle install` to install the new gem(s)
	310	+* 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/master/config/gitlab.yml.example#L53) as a reference)
	311	+* Add icons for the new provider into the [vendor/assets/images/authbuttons](https://github.com/gitlabhq/gitlabhq/tree/master/vendor/assets/images/authbuttons) directory (you can find some more popular ones over at https://github.com/intridea/authbuttons)
	312	+* Restart GitLab
	313	+
	314	+### Examples
	315	+
	316	+If you have successfully set up a provider that is not shipped with GitLab itself, please let us know.
	317	+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/Working-Custom-Omniauth-Provider-Configurations).
	318	+While we can't officially support every possible auth mechanism out there, we'd like to at least help those with special needs.
...	...