final move of files
[web.mtrack] / help / plugin / AuthHTTP
1 = MTrackAuth_HTTP =
2
3 By default, mtrack considers every user accessing the application via the web
4 server as an anonymous user.  Enabling this plugin will cause mtrack to either
5 recognize the HTTP authentication employed by your web server, or in the case
6 where the web server does not have authentication enabled, causes mtrack to
7 initiate HTTP authentication for itself.
8
9 == configuration ==
10
11 The plugin is loaded by adding a line like the following to your [help:ConfigIni config.ini]:
12
13 {{{
14 [plugins]
15 MTrackAuth_HTTP = /var/tmp/repos/svn.htgroup, /var/tmp/repos/svn.htpasswd
16 }}}
17
18 The first parameter is the path to an Apache style group file and the second is
19 the path to an Apache style password file.
20
21 == Basic vs Digest authentication ==
22
23 If your web server is not configured to perform authentication, mtrack will
24 initiate it for itself.  You have the option is implementing Basic or Digest
25 authentication.  Basic is more widely supported but should be used in
26 conjunction with SSL or other network level security so that the password
27 cannot be snooped.  Digest authentication does not transmit the password in
28 clear text so there is no risk of the password being snooped in the same way as
29 Basic auth.
30
31 If you choose to use Basic authentication, it should be noted that mtrack
32 supports only crypt based password encoding at this time.
33
34 === Enabling Digest authentication ===
35
36 By default, mtrack uses Basic authentication.  To use Digest authentication you
37 need to create a digest password file instead of the regular password file and
38 then tell mtrack to use digest: by prefixing the password file path with
39 {{{digest:}}}
40
41 {{{
42 [plugins]
43 MTrackAuth_HTTP = /var/tmp/repos/svn.htgroup, digest:/var/tmp/repos/svn.htpasswd
44 }}}
45
46 = Groups =
47
48 On successful authentication, the groups file is read and the groups of the
49 authenticated user are used to determine what rights the user has.
50