← Back to branch summary

~ubuntu-branches/ubuntu/natty/freeradius/natty-updates

« back to all changes in this revision

Viewing changes to man/man8/radiusd.8

  • Committer: Bazaar Package Importer
  • Author(s): Josip Rodin
  • Date: 2009-11-23 03:57:37 UTC
  • mfrom: (1.2.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 28.
  • Revision ID: james.westby@ubuntu.com-20091123035737-zsgtzhfych8hir68
Tags: 2.1.7+dfsg-1
http://bugs.debian.org/536623
http://bugs.debian.org/513484
http://bugs.debian.org/526175
http://bugs.debian.org/533396
http://bugs.debian.org/550143
* Adopting the package, closes: #536623.
* New upstream version, closes: #513484.
  + Fixes the blooper in unlang evaluation logic, closes: #526175.
* Used quilt (and added README.source), and moved upstream file patching
  into debian/patches/. The source is no longer in collab-maint git
  (to make it simpler for me to finally get this out the door), but
  kept the .gitignore should we need that again.
* Dropped the dialup_admin/bin/backup_radacct patch (integrated upstream).
* Dropped the raddb/Makefile patch (problem no longer exists upstream).
* Dropped the lib/packet.c lib/radius.c main/listen.c patches (was from
  upstream 2.0.5 anyway).
* Dropped references to otp.conf, it no longer exists upstream.
  Keep removing the conffile statoverride in prerm.
* Dropped references to snmp.conf, it no longer exists upstream.
  Keep removing the conffile statoverride in prerm.
* Ship /etc/freeradius/modules/* in the freeradius package.
* Stop shipping sites-enabled symlinks in the package and instead create
  them only on initial install, thanks to Matej Vela, closes: #533396.
* Add export PATH="${PATH:+$PATH:}/usr/sbin:/sbin" to the init script
  at the request of John Morrissey, closes: #550143.
* Stop installing /var/run/freeradius in the package to silence Lintian.
  The init script already recreates it at will.
* Remove executable bit from example.pl to silence Lintian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/man8/radiusd.8
1
 
.TH RADIUSD 8 "27 Dec 2007" "" "FreeRADIUS Daemon"
 
1
.TH RADIUSD 8 "08 Mar 2009" "" "FreeRADIUS Daemon"
2
2
.SH NAME
3
3
radiusd - Authentication, Authorization and Accounting server
4
4
.SH SYNOPSIS
24
24
protocols such as PAP, CHAP, MS-CHAP(v2), HTTP Digest, and EAP
25
25
(EAP-MD5, EAP-TLS, PEAP, EAP-TTLS, EAP-SIM, etc.).
26
26
 
27
 
Version 2.0 has preliminary support for Cisco's VLAN Query Protocol,
28
 
also known as VMPS.
 
27
It also has experimental support for Cisco's VLAN Query Protocol
 
28
(VMPS) and DHCP.
 
29
 
 
30
Please read the DEBUGGING section below.  It contains instructions
 
31
for quickly configuring the server for your local system.
29
32
.SH OPTIONS
30
33
The following command-line options are accepted by the server.
31
34
.IP \-C
57
60
This option MUST be used in conjunction with "-p".
58
61
.IP \-f
59
62
Do not fork, stay running as a foreground process.
60
 
.IP "\-n 
 
63
.IP "\-n \fIname\fP"
61
64
Read \fIraddb/name.conf\fP instead of \fIraddb/radiusd.conf\fP.
62
65
.IP "\-p \fIport\fP"
63
66
Normally radiusd listens on the ports specified in \fI/etc/services\fP
79
82
.IP \-v
80
83
Print server version information and exit.
81
84
.IP \-X
82
 
Debugging mode.  Equivalent to -sfxx -l stdout
 
85
Debugging mode.  Equivalent to "-sfxx -l stdout".  When trying to
 
86
understand how the server works, ALWAYS run it with "radiusd -X".
83
87
.IP \-x
84
88
Finer-grained debug mode. In this mode the server will print details
85
89
of every request on it's \fBstdout\fP output. You can specify this
95
99
server in debugging mode, you \fIwill not\fP be able to see what is
96
100
doing, and you \fIwill not\fP be able to correct any problems.
97
101
.PP
98
 
2) When editing the \fIradiusd.conf\fP file, change as little as
99
 
possible, especially in the \fIauthorize{}\fP section.  The ordering
100
 
of the modules is critical for the server to be able to
101
 
"automatically" figure out how to handle the request.  Changing the
102
 
order of the modules ensures that the server will not work.
103
 
.PP
104
 
3) When testing, start off by configuring a user and password in the
105
 
\fIusers\fP file.  So long as the server knows about a user, and has a
106
 
clear-text password for that user, \fBalmost all of the authentication
107
 
methods will "just work"\fP.
108
 
.PP
109
 
4) Gradually add more complex configurations to the server, while
110
 
testing them as you go.  If you start off by configuring the server in
111
 
a complex configuration, you will never be able to debug it.
 
102
2) Change as little as possible in the default configuration files.
 
103
The server contains a decade of experience with protocols, databases,
 
104
and different systems.  Its default configuration is designed to work
 
105
almost everywhere, and to do almost everything.
 
106
.PP
 
107
3) Make small changes to the configuration files, while testing each
 
108
change as you make it.  If the change works, save a copy of the
 
109
configuration, and make another change.  If the change doesn't work,
 
110
debug it, and try to understand why it doesn't work.
 
111
.PP
 
112
If you begin by making large changes to the server configuration, it
 
113
will never work, and you will never be able to debug it.
 
114
.PP
 
115
4) If you need to add a connection to a database FOO (e.g. LDAP or
 
116
SQL), then:
 
117
.PP
 
118
.in +0.3i
 
119
a) Edit raddb/modules/foo
 
120
.br
 
121
This file contains the default configuration for the module.  It
 
122
contains comments describing what can be configured, and what those
 
123
configuration entries mean.
 
124
.br
 
125
.br
 
126
b) Edit raddb/sites-available/default
 
127
.br
 
128
This file contains the default policy for the server.  e.g. "enable
 
129
CHAP, MS-CHAP, and EAP authentication".  Look in this file for all
 
130
references to your module "foo".  Read the comments, and remove the
 
131
leading hash '#' from the lines referencing the module.  This enables
 
132
the module.
 
133
.br
 
134
.br
 
135
c) Edit raddb/sites-available/inner-tunnel
 
136
.br
 
137
This file contains the default policy for the "tunneled" portion of
 
138
certain EAP methods.  Perform the same kind of edits as above, for the
 
139
"default" file..  If you are not using EAP (802.1X), then this step
 
140
can be skipped.
 
141
.br
 
142
.br
 
143
d) Start the server in debugging mode (
 
144
.B radiusd -X
 
145
), and start testing.
 
146
.in -0.3i
112
147
.PP
113
148
5) Ask questions on the mailing list
114
149
(freeradius-users@lists.freeradius.org).  When asking questions,
115
150
include the output from debugging mode (
116
151
.B radiusd -X
117
 
).  This information will allow people to help you.  Without it, your
118
 
message will get ignored.
 
152
).  This information will allow people to help you.  If you do not
 
153
include it, the first response to your message will be "post the
 
154
output of debug mode".
 
155
.PP
 
156
Ask questions earlier, rather than later.  If you cannot solve a
 
157
problem in a day, ask a question on the mailing list.  Most questions
 
158
have been seen before, and can be answered quickly.
119
159
.SH BACKGROUND
120
160
\fBRADIUS\fP is a protocol spoken between an access server, typically
121
161
a device connected to several modems or ISDN lines, and a \fBradius\fP