clarify that this uses REMOTE_USER CGI
authorJoey Hess <joey@kitenet.net>
Tue, 7 Aug 2012 15:48:52 +0000 (11:48 -0400)
committerJoey Hess <joey@kitenet.net>
Tue, 7 Aug 2012 15:48:52 +0000 (11:48 -0400)
doc/plugins/httpauth.mdwn

index 0eda5554f452ea41b2e6f7eb451d5fa04e9e62dd..2fae07739ea7c33abe4117d816f883b26c949ced 100644 (file)
@@ -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