X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f398ad035b973608d380c9939ea845d8e2a0cdc2..72c3b81efb1079f8db070ac89e97e9b7bcedd61b:/doc/plugins/httpauth.mdwn

diff --git a/doc/plugins/httpauth.mdwn b/doc/plugins/httpauth.mdwn
index 0eda5554f..58a08599c 100644
--- a/doc/plugins/httpauth.mdwn
+++ b/doc/plugins/httpauth.mdwn
@@ -2,7 +2,9 @@
 [[!tag type/auth]]
 
 This plugin allows HTTP basic authentication to be used to log into the
-wiki. 
+wiki. In this mode, the web browser authenticates the user by some means,
+and sets the `REMOTE_USER CGI` environment variable. This plugin trusts
+that if that variable is set, the user is authenticated.
 
 ## fully authenticated wiki
 
@@ -33,3 +35,12 @@ configure `httpauth_pagespec` in the setup file. This makes Edit
 links on pages that match the [[ikiwiki/PageSpec]] automatically use
 the `cgiauthurl`, and prevents matching pages from being edited by
 users authentication via other methods.
+
+## Using httpauth with nginx
+
+You have to pass the $remote_user variable to the CGI:
+
+    location /ikiwiki.cgi {
+        fastcgi_param REMOTE_USER $remote_user;
+        ....
+    }