doc/plugins/httpauth.mdwn

   1 [[!template id=plugin name=httpauth author="Alec Berryman"]]
   2 [[!tag type/auth]]
   3
   4 This plugin allows HTTP basic authentication to be used to log into the
   5 wiki.
   6
   7 ## fully authenticated wiki
   8
   9 One way to use the plugin is to configure your web server to require
  10 HTTP basic authentication for any access to the directory containing the
  11 wiki (and `ikiwiki.cgi`). The authenticated user will be automatically
  12 signed into the wiki. This method is suitable only for private wikis.
  13
  14 ## separate cgiauthurl
  15
  16 To use httpauth for a wiki where the content is public, and where
  17 the `ikiwiki.cgi` needs to be usable without authentication (for searching
  18 and so on), you can configure a separate url that is used for
  19 authentication, via the `cgiauthurl` option in the setup file. This
  20 url will then be redirected to whenever authentication is needed.
  21
  22 A typical setup is to make an `auth` subdirectory, and symlink `ikiwiki.cgi`
  23 into it. Then configure the web server to require authentication only for
  24 access to the `auth` subdirectory. Then `cgiauthurl` is pointed at this
  25 symlink.