Skip to content

Commit cb4f48e

Browse files
committed
Update documentation
1 parent 0a4a0ed commit cb4f48e

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,19 @@ class parameter as a hash.
291291
}
292292
```
293293

294+
### Enable external authentication
295+
296+
To enable pure-ftpd external authentication use the `extauth_enabled` and `extauth_handler`.
297+
The `extauth_handler` can be a local path to a file already on the ftp server or a remote
298+
file from the puppet server if the argument starts with `puppet://`.
299+
300+
```puppet
301+
class { 'pureftpd':
302+
extauth_enabled => true,
303+
extauth_handler => 'puppet:///modules/profiles/ftp-auth-handler.py',
304+
}
305+
```
306+
294307
### Pedantic Example
295308

296309
```puppet

manifests/init.pp

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@
2929
#
3030
# Optional, defaults to `{}`.
3131
#
32+
# [*extauth_enabled*]
33+
# Boolean variable to enable pure-ftpd external authentication
34+
#
35+
# Optional, defaults to false
36+
#
37+
# [*extauth_handler*]
38+
# Local or remote path (puppet path) to pure-ftpd external authentication handler.
39+
# Can refer a local file on the server or copy one from the puppet master if the argument
40+
# starts with puppet://
41+
#
42+
# Optional, defaults to `''`
43+
#
3244
# === Examples
3345
#
3446
# class { 'pureftpd':
@@ -37,6 +49,8 @@
3749
# ipv4only => 'Yes',
3850
# passiveportrange => '49999:59999',
3951
# },
52+
# extauth_enabled => true,
53+
# extauth_handler => 'puppet:///modules/profiles/ftp-auth-handler.py'
4054
# }
4155
#
4256
#

0 commit comments

Comments
 (0)