better documentation for ipaddr & friends. Fixes #1921
authorAlan T. DeKok <aland@freeradius.org>
Wed, 22 Feb 2017 15:48:51 +0000 (10:48 -0500)
committerAlan T. DeKok <aland@freeradius.org>
Wed, 22 Feb 2017 15:49:45 +0000 (10:49 -0500)
raddb/sites-available/default

index 7b00743..0473aea 100644 (file)
@@ -85,16 +85,35 @@ listen {
        #  proxy listeners are automatically created.
 
        #  ipaddr/ipv4addr/ipv6addr - IP address on which to listen.
-       #  Out of several options the first one will be used.
-       #
-       #  Allowed values are:
-       #       IPv4 address (e.g. 1.2.3.4, for ipv4addr/ipaddr)
-       #       IPv6 address (e.g. 2001:db8::1, for ipv6addr/ipaddr)
-       #       hostname     (radius.example.com,
-       #                       A record for ipv4addr,
-       #                       AAAA record for ipv6addr,
-       #                       A or AAAA record for ipaddr)
-       #       wildcard     (*)
+       #  If multiple ones are listed, only the first one will
+       #  be used, and the others will be ignored.
+       #
+       #  The configuration options accept the following syntax:
+       #
+       #  ipv4addr - IPv4 address (e.g.192.0.2.3)
+       #           - wildcard (i.e. *)
+       #           - hostname (radius.example.com)
+       #             Only the A record for the host name is used.
+       #             If there is no A record, an error is returned,
+       #             and the server fails to start.
+       #
+       #  ipv6addr - IPv6 address (e.g. 2001:db8::1)
+       #           - wildcard (i.e. *)
+       #           - hostname (radius.example.com)
+       #             Only the AAAA record for the host name is used.
+       #             If there is no AAAA record, an error is returned,
+       #             and the server fails to start.
+       #
+       #  ipaddr   - IPv4 address as above
+       #           - IPv6 address as above
+       #           - wildcard (i.e. *), which means IPv4 wildcard.
+       #           - hostname
+       #             If there is only one A or AAA record returned
+       #             for the host name, it is used.
+       #             If multiple A or AAA records are returned
+       #             for the host name, only the first one is used.
+       #             If both A and AAA records are returned
+       #             for the host name, only the A record is used.
        #
        # ipv4addr = *
        # ipv6addr = *