]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
replace raddb/users with `users`, to make it more generic
authorAlan T. DeKok <aland@freeradius.org>
Sat, 24 Jan 2026 13:33:58 +0000 (08:33 -0500)
committerAlan T. DeKok <aland@freeradius.org>
Sat, 24 Jan 2026 13:50:58 +0000 (08:50 -0500)
doc/antora/modules/ROOT/pages/faq.adoc
doc/antora/modules/ROOT/pages/trouble-shooting/server.adoc
doc/antora/modules/ROOT/pages/trouble-shooting/user.adoc
doc/antora/modules/reference/pages/raddb/mods-config/files/users.adoc

index fb3319033c9dc77cdbc5cb9592ac2ace065828e7..a21574474c241356f8abd1a8d8cde5218cb86782 100644 (file)
@@ -28,7 +28,7 @@ authentication and accounting practices. See xref:concepts:components/architectu
 FreeRADIUS is an open-source product with all the benefits of open-source software that includes flexibility, scalibility, and cost-effectivness. FreeRADIUS has many features not found in other free and commercial versions. Some of these features are:
 
 * Access based on huntgroups.
-* Multiple DEFAULT entries in raddb/users file.
+* Multiple DEFAULT entries in `users` file.
 * All users file entries can optionally `fall through`.
 * Caches all config files in-memory.
 * Supports Simultaneous-Use = X parameter to prevent double logins.
@@ -116,7 +116,7 @@ DEFAULT Group == "daysonly", Login-Time := "Any0800-2000"
 
 === Can I permit access to any user regardless of password?
 
-Yes. Edit the raddb/users file with the following entry on the first line (top of the file). This entry accepts everybody on to the network.
+Yes. Edit the `users` file with the following entry on the first line (top of the file). This entry accepts everybody on to the network.
 
     DEFAULT Auth-Type := Accept
 
@@ -200,7 +200,7 @@ Yes. The most common approach is to just assign non-globally-routable IP address
 
 Depending on your internal network configuration, you may need to set up internal routes for those addresses, and if you don't want them to do anything besides SMTP and POP3 within your network, you'll have to set up ACLs on your dialup interfaces allowing only ports 25 and 110 through.
 
-User entry in raddb/users file example
+User entry in `users` file example
 [%collapsible]
 ====
 
@@ -242,7 +242,7 @@ and
        DEFAULT Huntgroup-Name ="somehunt", Auth-Type=PAM, Pam-Auth="radhunt", Simultaneous-Use=1
                Fall-Through = Yes
 
-With this method, I have NO users on /etc/password and NO need for lots of lines on /etc/raddb/users. time to search for a db enabled pam_listfile module
+With this method, I have NO users on /etc/password and NO need for lots of lines on `users`. time to search for a db enabled pam_listfile module
 
 === Is the RADIUS server broken after an upgrade?
 
index 904de1972c4792f61ffd9fbe8b3f77e38479bc34..9aec0cd087729d9fbefd3d5c6481af65352325be 100644 (file)
@@ -3,7 +3,7 @@
 
 == Why does PAP authentication work but CHAP fails?
 
-You're not using plaintext passwords in the raddb/users file or other password store. The CHAP protocol requires a plaintext password on the radius server side, for PAP it doesn't matter.
+You're not using plaintext passwords in the `users` file or other password store. The CHAP protocol requires a plaintext password on the radius server side, for PAP it doesn't matter.
 
 To use CHAP, each user entry must shown in this format:
 
@@ -27,14 +27,14 @@ If FreeRADIUS is configured to use threads, then nothing is wrong.  Newer Linux
        * `ps auxH`
 
 
-== I can't get RADIUS to pick up changes in the raddb/users.
+== I can't get RADIUS to pick up changes in the `users`.
 
 The server reads the config files once at startup. This is very efficient, but you need to tell the server somehow to re-read its config files after you made a change. This can be done by sending the server a SIGHUP (signal '1' on almost if not all UNIX systems). The server writes its PID in
 `/var/run/radiusd.pid`, so a simple UNIX command to do this would be:
 
        kill -1 `cat /var/run/radiusd.pid`
 
-Some people are tempted to do this every 5 minutes so that changes come through automatically. That is not a good idea it takes some time to re-read the config files and the server may drop a few authentication requests at that time. A better idea is to use a so-called "timestamp file" and only send a SIGHUP if the raddb/users file changed since the last time. See the example SIGHUP script.
+Some people are tempted to do this every 5 minutes so that changes come through automatically. That is not a good idea it takes some time to re-read the config files and the server may drop a few authentication requests at that time. A better idea is to use a so-called "timestamp file" and only send a SIGHUP if the `users` file changed since the last time. See the example SIGHUP script.
 
 .SIGHUP script
 [%collapsible]
@@ -91,9 +91,9 @@ configuration files. The problem with this approach is that any syntax errors in
 ====
 
 
-=== Do I need the commas in the raddb/users file?
+=== Do I need the commas in the `users` file?
 
-Yes. Commas link lists of attributes together and must be present for the data to be parsed properly. The general format for a raddb/users file entry is:
+Yes. Commas link lists of attributes together and must be present for the data to be parsed properly. The general format for a `users` file entry is:
 
        name Check-Item = Value, ..., Check-Item = Value
                Reply-Item = Value,
@@ -111,7 +111,7 @@ The dots represents a repetition of attributes.
 * Commas go *between* Reply-Items.
 * The last line of the reply-item list ends *without* a comma.
 
-Check-Items are used to match attributes in a request packet or to set server parameters. Reply-Items are used to set attributes which are to go in the reply packet. So things like Simultaneous-Use go on the first line of a raddb/users file entry and Framed-IP-Address goes on any following line.
+Check-Items are used to match attributes in a request packet or to set server parameters. Reply-Items are used to set attributes which are to go in the reply packet. So things like Simultaneous-Use go on the first line of a `users` file entry and Framed-IP-Address goes on any following line.
 
 
 === Why are all the Incoming Authentication-Request passwords corrupt?
index 030c6410a03e77ca9dff24d5fc6ffa7c32f641de..8aadf4cd5053e7469e66d15d5e414f6aa6272103 100644 (file)
@@ -12,7 +12,7 @@ The following entry denies access to one specific user. Note that it MUST be put
        foo Auth-Type := Reject
                Reply-Message = "foo is not allowed to dial-in"
 
-The following entry denies access to a group of users. The same restrictions as above on location in the raddb/users file also apply:
+The following entry denies access to a group of users. The same restrictions as above on location in the `users` file also apply:
 
        DEFAULT Group == "disabled", Auth-Type := Reject
                Reply-Message = "Your account has been disabled"
index 000d00ee26bfccc858310fccbe9626c2722182d0..d7d1da5a9bdc1eb1dd4bb8d367d57d045109be51 100644 (file)
@@ -55,7 +55,7 @@ The `$INCLUDE` directive reads another file into the current `users` file, as if
 
 The filename can be absolute, and begin with `/`.  That usage is not recommended.
 
-If the filename does not begin with `/`, it is a relative filename.  The module reads the file which is relative to the current file being processed.  For example, if the current file is `/etc/raddb/mods-config/files/users` and that file contains a directive `$INCLUDE next`, the file which will be read is `/etc/raddb/mods-config/files/next`.
+If the filename does not begin with `/`, it is a relative filename.  The module reads the file which is relative to the current file being processed.  For example, if the current file is `mods-config/files/users` and that file contains a directive `$INCLUDE next`, the file which will be read is `mods-config/files/next`.
 
 The `$INCLUDE` can be nested to any depth, subject only to available memory.  The module does not cross-reference `$INCLUDE` files, so it is possible for a file to `$INCLUDE` itself in an infinite loop.  This practice is not recommended.  When this misconfiguration happens, the server will run out of memory processing the file, and then exit.