Commit d84c6632 authored by Jonathan Gazeley's avatar Jonathan Gazeley
Browse files

Update documentation to match reality

parent 10722d20
......@@ -34,7 +34,7 @@
## Overview
This module installs and configures [FreeRADIUS](http://freeradius.org/) server
on Linux. It supports FreeRADIUS 2.x and 3.x. It was designed with CentOS in mind
on Linux. It supports FreeRADIUS 3.x only. It was designed with CentOS in mind
but should work on other distributions.
## Module Description
......@@ -237,7 +237,7 @@ freeradius::client { "wlan-controllers":
##### `ip`
The IP address of the client or range in CIDR format. For IPv6, use `ipv6addr`. `ip` and `ip6` are mutually exclusive but one must be supplied.
On FreeRADIUS 2, specify the netmask separately. Default: `undef`.
Default: `undef`.
##### `ip6`
The IPv6 address of the client or range in CIDR format. `ip` and `ip6` are mutually exclusive but one must be supplied. Default: `undef`.
......@@ -420,19 +420,16 @@ Number of seconds to wait for LDAP query to finish. Default: `10`
##### `start`
Connections to create during module instantiation. If the server cannot create specified number of
connections during instantiation it will exit. Set to 0 to allow the server to start without the
directory being available. This option only works with FR3; setting it on FR2 will have no effect.
Default: `${thread[pool].start_servers}`
directory being available. Default: `${thread[pool].start_servers}`
##### `min`
Minimum number of connections to keep open. This option only works with FR3; setting it on FR2 will have no effect.
Default: `${thread[pool].min_spare_servers}`
Minimum number of connections to keep open. Default: `${thread[pool].min_spare_servers}`
##### `max`
Maximum number of connections. Default: `${thread[pool].max_servers}`
##### `spare`
Spare connections to be left idle. This option only works with FR3; setting it on FR2 will have no effect.
Default: `${thread[pool].max_spare_servers}`
Spare connections to be left idle. Default: `${thread[pool].max_spare_servers}`
##### `starttls`
Set this to 'yes' to use TLS encrypted connections to the LDAP database by using the StartTLS extended operation.
......@@ -716,9 +713,10 @@ Provide content of template item. Specify only one of `source` or `content`.
## Limitations
This module is targeted at FreeRADIUS 2.x running on CentOS 6 and FreeRADIUS 3.x running
on CentOS 7. It has not been thoroughly tested on other distributions, but might work.
Likely sticking points with other distros are the names of packages, services and file paths.
This module is targeted at FreeRADIUS 3.x running on CentOS 7. It will not work on
FreeRADIUS 2.x. It has not been thoroughly tested on other distributions, but
might work. Likely sticking points with other distros are the names of packages,
services and file paths.
This module was written for use with Puppet 3.6 and 3.7, but should be quite agnostic
to new versions of Puppet.
......@@ -730,9 +728,6 @@ use probably haven't been written. Please send pull requests with new features a
bug fixes. You are also welcome to file issues but I make no guarantees of
development effort if the features aren't useful to my employer.
When contributing code, please ensure your change works on FreeRADIUS 2.x and 3.x - at
least until this module drops support for 2.x.
## Release Notes
### 1.3.0
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment