etc: Add environment option to run init.d/ashd silently.

[ashd.git] / doc / htextauth.doc

diff --git a/doc/htextauth.doc b/doc/htextauth.doc
index d124652..8c3b6f7 100644 (file)
--- a/doc/htextauth.doc
+++ b/doc/htextauth.doc
@@ -28,6 +28,11 @@ so that the authentication program does not have to be called for each
 and every request. Cached credentials are cleared from the cache when
 they have not been used for over 30 minutes.
 
+When authentication succeeds, *htextauth* removes the HTTP
+`Authorization` header from the request before passing the request on
+to the child handler, and adds the `X-Ash-Remote-User` header in its
+place, containing the name of the authenticated user.
+
 If the child handler exits, *htextauth* exits as well.
 
 OPTIONS
@@ -73,6 +78,16 @@ the client.
 Note that *htextauth* will wait for the authentication program to exit
 and not process any other requests until then.
 
+FILES
+-----
+The file `etc/extauth/vhtpasswd` in the *ashd* source distribution is
+a simple authenticator program (written in Python) that can be used
+with *htextauth*, which verifies the given credentials against a
+simple database of users with encrypted passwords. It can be used as
+is, or as a simple example of how to produce authenticator
+programs. The accompanying `mkhtpasswd` program can be used to
+maintain the password database.
+
 AUTHOR
 ------
 Fredrik Tolf <fredrik@dolda2000.com>