Remove mentions of Auth-Type = System from docs
[freeradius.git] / man / man5 / rlm_unix.5
1 .\"     # DS - begin display
2 .de DS
3 .RS
4 .nf
5 .sp
6 ..
7 .\"     # DE - end display
8 .de DE
9 .fi
10 .RE
11 .sp
12 ..
13 .TH rlm_unix 5 "17 February 2005" "" "FreeRADIUS Module"
14 .SH NAME
15 rlm_unix \- FreeRADIUS Module
16 .SH DESCRIPTION
17 The \fIrlm_unix\fP module reads crypt(3) passwords from the system
18 password file, and allows the server to use them for authentication.
19 The module also provides FreeRADIUS an interface into a radwtmp file
20 (used by "radlast") when added to the accounting section.
21 .PP
22 The \fIrlm_unix\fP module should be listed in the
23 "authenticate" section.  Please see the default \fIradiusd.conf\fP
24 shipped with the server for an example of the correct usage of this
25 module.
26 .PP
27 As of FreeRADIUS 1.1.0, the module no longer reads, or caches
28 /etc/passwd, /etc/shadow, or /etc/group.  If you wish to cache those
29 files, see \fIrlm_passwd\fP.  Most, if not all, configurations should
30 not need those files to be cached.
31 .PP
32 The main configuration items to be aware of are:
33 .IP radwtmp
34 The path to the system wtmp file to be used for keeping the database
35 of online users as read by the 'radlast' program.
36 .SH CONFIGURATION
37 .PP
38 .DS
39 modules {
40   ...
41 .br
42   unix {
43 .br
44     radwtmp = ${logdir}/radwtmp
45 .br
46   }
47 .br
48   ...
49 .br
50 }
51 .DE
52 .PP
53 .SH SECTIONS
54 .BR authentication,
55 .BR accounting
56 .PP
57 .SH FILES
58 .I /etc/raddb/radiusd.conf,
59 .PP
60 .SH "SEE ALSO"
61 .BR radiusd (8),
62 .BR radiusd.conf (5),
63 .BR rlm_passwd (5),
64 .BR radlast (1)
65 .SH AUTHORS
66 Chris Parker, cparker@segv.org