Merge branch 'master' into debian-jessie-backports

[git.ikiwiki.info.git] / doc / plugins / httpauth.mdwn

diff --git a/doc/plugins/httpauth.mdwn b/doc/plugins/httpauth.mdwn
index 0eda5554f452ea41b2e6f7eb451d5fa04e9e62dd..58a08599c7a2d010c945a600b921107bf78e7f32 100644 (file)
--- 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
 [[!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
 
 
 ## 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.
 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;
+        ....
+    }