aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/httpauth.mdwn
blob: a7aac558b535fed7830376c2086aa3f65185f875 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[[!template id=plugin name=httpauth author="Alec Berryman"]]
[[!tag type/auth]]

This plugin allows HTTP basic authentication to be used to log into the
wiki. 

## fully authenticated wiki

One way to use the plugin is to configure your web server to require
HTTP basic authentication for any access to the directory containing the
wiki (and `ikiwiki.cgi`). The authenticated user will be automatically
signed into the wiki. This method is suitable only for private wikis.

## separate cgiauthurl

To use httpauth for a wiki where the content is public, and where
the `ikiwiki.cgi` needs to be usable without authentication (for searching,
or logging in using other methods, and so on), you can configure a separate
url that is used for authentication, via the `cgiauthurl` option in the setup
file. This url will then be redirected to when a user chooses to log in using
httpauth.

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.