add site documentation for HTTP header authentication

diff --git a/src/site/setup_authentication.mkd b/src/site/setup_authentication.mkd
index a3bf4451aa27d097b1d468218fc5dce03b73ae7d..71136675d8e721a098b3b378c491e3ca5834341c 100644 (file)
--- a/src/site/setup_authentication.mkd
+++ b/src/site/setup_authentication.mkd
@@ -8,6 +8,7 @@ Gitblit supports additional authentication mechanisms aside from it's internal o
 * Windows authentication\r
 * PAM authentication\r
 * Htpasswd authentication\r
+* HTTP header authentication\r
 * Redmine auhentication\r
 * Salesforce.com authentication\r
 * Servlet container authentication\r
@@ -101,6 +102,17 @@ Htpasswd authentication allows you to maintain your user credentials in an Apach
     realm.authenticationProviders = htpasswd\r
     realm.htpasswd.userFile = /path/to/htpasswd\r
 \r
+### HTTP Header Authentication\r
+\r
+HTTP header authentication allows you to use existing authentication performed by a trusted frontend, such as a reverse proxy. Ensure that when used, gitblit is ONLY availabe via the trusted frontend, otherwise it is vulnerable to a user adding the header explicitly.\r
+\r
+By default, no user or team header is defined, which results in all authentication failing this mechanism. The user header can also be defined while leaving the team header undefined, which causes users to be authenticated from the headers, but team memberships to be maintained locally.\r
+\r
+    realm.httpheader.userheader = REMOTE_USER\r
+    realm.httpheader.teamheader = X-GitblitExample-GroupNames\r
+    realm.httpheader.teamseparator = ,\r
+    realm.httpheader.autoCreateAccounts = false\r
+\r
 ### Redmine Authentication\r
 \r
 You may authenticate your users against a Redmine installation as long as your Redmine install has properly enabled [API authentication](http://www.redmine.org/projects/redmine/wiki/Rest_Api#Authentication).  This user service only supports user authentication; it does not support team creation based on Redmine groups.  Redmine administrators will also be Gitblit administrators.\r