Commit 046ed0ce authored by Jonathan Gazeley's avatar Jonathan Gazeley
Browse files

Improve documentation

parent 4e3666e0
......@@ -40,13 +40,19 @@ This module provides several classes and defined types which take parameters.
The `freeradius` class installs the base server. In the early releases, this class does not
have many parameters as most values are hard-coded. I am working on parameterising more
of the settings to increase flexibility.
of the settings to increase flexibility. Patches are welcome.
### Resources
#### `freeradius::attr`
Install attribute filters
Install arbitrary attribute filters from a flat flit. These are installed in `/etc/raddb/attr.d`
```
freeradius::attr { 'eduroamlocal':
source => 'puppet:///modules/site_freeradius/eduroamlocal',
}
```
#### `freeradius::client`
......@@ -86,7 +92,11 @@ freeradius::config { 'realm-checks.conf':
#### `freeradius::instantiate`
Instantiate a module
Instantiate a module that is not automatically instantiated.
```
freeradius::instantiate { 'mymodule': }
```
#### `freeradius::module`
......@@ -113,6 +123,12 @@ freeradius::policy { 'my-policies':
Install a helper script, e.g. which might be called upon by a virtual server. These are
placed in `/etc/raddb/scripts` and are not automatically included by the server.
```
freeradius::site { 'myperlscript.pl':
source => 'puppet:///modules/site_freeradius/myperlscript.pl',
}
```
#### `freeradius::site`
Install a virtual server (a.k.a. site) from a flat file. Sites are install directly
......@@ -153,6 +169,3 @@ development effort if the features aren't useful to my employer.
## Release Notes
If you aren't using changelog, put your release notes here (though you should
consider using changelog). You may also add any additional sections you feel are
necessary or important to include here. Please use the `## ` header.
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