last re-arrangement
authorAlan T. DeKok <aland@freeradius.org>
Thu, 20 Mar 2014 17:51:20 +0000 (13:51 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Thu, 20 Mar 2014 17:51:20 +0000 (13:51 -0400)
raddb/README.rst

index 0c7d71d..58435a4 100644 (file)
@@ -384,6 +384,100 @@ The ``yubikey`` module can be used to forward yubikey OTP token
 values to a Yubico validation server, or decrypt the token 
 using a PSK.
 
+Deleted Modules
+---------------
+
+The following modules have been deleted, and are no longer supported
+in Version 3.  If you are using one of these modules, your
+configuration can probably be changed to not need it.  Otherwise email
+the freeradius-devel list, and ask about the module.
+
+rlm_acct_unique
+~~~~~~~~~~~~~~~
+
+This module has been replaced by the "acct_unique" policy.  See
+raddb/policy.d/accounting.
+
+The method for calculating the value of acct_unique has changed.
+However, as this method was configurable, this change should not
+matter.  The only issue is in having a v2 and v3 server writing to the
+same database at the same time.  They will calculate different values
+for Acct-Unique-Id.
+
+rlm_acctlog
+~~~~~~~~~~~
+
+You should use rlm_linelog instead.  That module has a superset of the
+acctlog functionality.
+
+rlm_attr_rewrite
+~~~~~~~~~~~~~~~~
+
+The attr_rewrite module looked for an attribute, and then re-wrote it,
+or created a new attribute.  All of that can be done in "unlang".
+
+A sample configuration in "unlang" is::
+
+  if (request:Calling-Station-Id) {
+    update request {
+      Calling-Station-Id := "...."
+    }
+  }
+
+We suggest updating all uses of attr_rewrite to use unlang instead.
+
+rlm_checkval
+~~~~~~~~~~~~
+
+The checkval module compared two attributes.  All of that can be done in "unlang"::
+
+  if (&request:Calling-Station-Id == &control:Calling-Station-Id) {
+    ok
+  }
+
+We suggest updating all uses of checkval to use unlang instead.
+
+rlm_dbm
+~~~~~~~
+
+No one seems to use it.  There is no sample configuration for it.
+There is no speed advantage to using it over the "files" module.
+Modern systems are fast enough that 10K entries can be read from the
+"users" file in about 10ms.  If you need more users than that, use a
+real database such as SQL.
+
+rlm_fastusers
+~~~~~~~~~~~~~
+
+No one seems to use it.  It has been deprecated since Version 2.0.0.
+The "files" module was rewritten so that the "fastusers" module was no
+longer necessary.
+
+rlm_policy
+~~~~~~~~~~
+
+No one seems to use it.  Almost all of its functionality is available
+via "unlang".
+
+rlm_sim_files
+~~~~~~~~~~~~~
+
+The rlm_sim_files module has been deleted.  It was never marked "stable",
+and was never used in a production environment.  There are better ways
+to test EAP.
+
+If you want similar functionality, see rlm_passwd.  It can read CSV
+files, and create attributes from them.
+
+rlm_sql_log
+~~~~~~~~~~~
+
+This has been replaced with the "null" sql driver.  See
+raddb/mods-available/sql for an example configuration.
+
+The main SQL module has more functionality than rlm_sql_log, and
+results in less code in the server.
+
 Other Functionality
 -------------------
 
@@ -555,100 +649,6 @@ optimized away::
 That configuration will never show the ``if (1)`` output in debugging mode.
 
 
-Deleted Modules
----------------
-
-The following modules have been deleted, and are no longer supported
-in Version 3.  If you are using one of these modules, your
-configuration can probably be changed to not need it.  Otherwise email
-the freeradius-devel list, and ask about the module.
-
-rlm_acct_unique
-~~~~~~~~~~~~~~~
-
-This module has been replaced by the "acct_unique" policy.  See
-raddb/policy.d/accounting.
-
-The method for calculating the value of acct_unique has changed.
-However, as this method was configurable, this change should not
-matter.  The only issue is in having a v2 and v3 server writing to the
-same database at the same time.  They will calculate different values
-for Acct-Unique-Id.
-
-rlm_acctlog
-~~~~~~~~~~~
-
-You should use rlm_linelog instead.  That module has a superset of the
-acctlog functionality.
-
-rlm_attr_rewrite
-~~~~~~~~~~~~~~~~
-
-The attr_rewrite module looked for an attribute, and then re-wrote it,
-or created a new attribute.  All of that can be done in "unlang".
-
-A sample configuration in "unlang" is::
-
-  if (request:Calling-Station-Id) {
-    update request {
-      Calling-Station-Id := "...."
-    }
-  }
-
-We suggest updating all uses of attr_rewrite to use unlang instead.
-
-rlm_checkval
-~~~~~~~~~~~~
-
-The checkval module compared two attributes.  All of that can be done in "unlang"::
-
-  if (&request:Calling-Station-Id == &control:Calling-Station-Id) {
-    ok
-  }
-
-We suggest updating all uses of checkval to use unlang instead.
-
-rlm_dbm
-~~~~~~~
-
-No one seems to use it.  There is no sample configuration for it.
-There is no speed advantage to using it over the "files" module.
-Modern systems are fast enough that 10K entries can be read from the
-"users" file in about 10ms.  If you need more users than that, use a
-real database such as SQL.
-
-rlm_fastusers
-~~~~~~~~~~~~~
-
-No one seems to use it.  It has been deprecated since Version 2.0.0.
-The "files" module was rewritten so that the "fastusers" module was no
-longer necessary.
-
-rlm_policy
-~~~~~~~~~~
-
-No one seems to use it.  Almost all of its functionality is available
-via "unlang".
-
-rlm_sim_files
-~~~~~~~~~~~~~
-
-The rlm_sim_files module has been deleted.  It was never marked "stable",
-and was never used in a production environment.  There are better ways
-to test EAP.
-
-If you want similar functionality, see rlm_passwd.  It can read CSV
-files, and create attributes from them.
-
-rlm_sql_log
-~~~~~~~~~~~
-
-This has been replaced with the "null" sql driver.  See
-raddb/mods-available/sql for an example configuration.
-
-The main SQL module has more functionality than rlm_sql_log, and
-results in less code in the server.
-
 Dialup_admin
 ------------