New build path variable

[freeradius.git] / raddb / sqlippool.conf

diff --git a/raddb/sqlippool.conf b/raddb/sqlippool.conf
index 8f47eb3..94fabc0 100644 (file)
--- a/raddb/sqlippool.conf
+++ b/raddb/sqlippool.conf
@@ -1,49 +1,67 @@
-#  Configuration for the SQL based IPPool module (rlm_sqlippool)
-#
-#  The database schemas are available at:
-#
-#       doc/examples/*.sql
-#
-#  $Id$
+##  Configuration for the SQL based IP Pool module (rlm_sqlippool)
+##
+##  The database schemas are available at:
+##
+##       raddb/sql/DB/ippool.sql
+##
+##  $Id$
 
 sqlippool {
 
- ## SQL instance to use (from sql.conf)
+ #########################################
+ ## SQL instance to use (from sql.conf) ##
+ ##
+ ##  If you have multiple sql instances, such as "sql sql1 {...}",
+ ##  use the *instance* name here: sql1.
+ #########################################
  sql-instance-name = "sql"
 
- ## Table to keep ippool info
+ ## SQL table to use for ippool range and lease info
  ippool_table = "radippool"
 
- ## lease_duration. fix for lost acc-stop packets
+ ## IP lease duration. (Leases expire even if Acct Stop packet is lost)
  lease-duration = 3600
 
  ## Attribute which should be considered unique per NAS
- ## Using NAS-Port gives behaviour similar to rlm_ippool. Calling-Station-Id is for NAS that send fixed NAS-Port
+ ## Using NAS-Port gives behaviour similar to rlm_ippool. (And ACS)
+ ## Using Calling-Station-Id works for NAS that send fixed NAS-Port
+ ## ONLY change this if you know what you are doing!
  pool-key = "%{NAS-Port}"
  # pool-key = "%{Calling-Station-Id}"
 
- ## Logging configuration.
+ ################################################################
+ #
+ #  WARNING: MySQL has certain limitations that means it can
+ #           hand out the same IP address to 2 different users.
+ #
+ #           We suggest using an SQL DB with proper transaction
+ #           support, such as PostgreSQL, or using MySQL
+ #          with InnoDB.
+ #
+ ################################################################
+
+ #
+ #  Use the same database as configured in the "sql" module, "database"
+ #  configuration item.  Change the "postgresql" name below to be the
+ #  same as the "database" field of the SQL module referred to in the
+ #  "sql-instance-name", above.
+ #
+$INCLUDE sql/postgresql/ippool.conf
+ 
+ ## Logging configuration. (Comment out to disable logging)
  sqlippool_log_exists = "Existing IP: %{reply:Framed-IP-Address} \
   (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
- sqlippool_log_success = "Allocated IP: %{reply:Framed-IP-Address} from %{check:Pool-Name} \
+ sqlippool_log_success = "Allocated IP: %{reply:Framed-IP-Address} from %{control:Pool-Name} \
   (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
  sqlippool_log_clear = "Released IP %{Framed-IP-Address}\
  (did %{Called-Station-Id} cli %{Calling-Station-Id} user %{User-Name})"
 
- sqlippool_log_failed = "IP Allocation FAILED from %{check:Pool-Name} \
+ sqlippool_log_failed = "IP Allocation FAILED from %{control:Pool-Name} \
   (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
  sqlippool_log_nopool = "No Pool-Name defined \
   (did %{Called-Station-Id} cli %{Calling-Station-Id} port %{NAS-Port} user %{User-Name})"
 
-
-
- ## Uncomment the appropriate config file for your SQL dialect
-
- # $INCLUDE ${confdir}/sql/mysql-dialup.conf
- $INCLUDE ${confdir}/sql/postgresql-ippool-dialup.conf
-
-
 }