(no commit message)

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

diff --git a/doc/plugins/httpauth.mdwn b/doc/plugins/httpauth.mdwn
index a7aac558b535fed7830376c2086aa3f65185f875..2fae07739ea7c33abe4117d816f883b26c949ced 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
-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
 
@@ -24,3 +26,12 @@ A typical setup is to make an `auth` subdirectory, and symlink `ikiwiki.cgi`
 into it. Then configure the web server to require authentication only for
 access to the `auth` subdirectory. Then `cgiauthurl` is pointed at this
 symlink.
+
+## using only httpauth for some pages
+
+If you want to only use httpauth for editing some pages, while allowing
+other authentication methods to be used for other pages, you can
+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.