1 files changed, 25 insertions, 0 deletions
diff --git a/roles/ftp/Readme.md b/roles/ftp/Readme.md
new file mode 100644
index 0000000..e68df3a
--- /dev/null
+++ b/roles/ftp/Readme.md
@@ -0,0 +1,25 @@
+# FTP
+
+Simple PB for pure-ftpd FTP server.
+
+LDAP mode is untested.
+
+Creates a new unit, the Debian wrapper for pure-ftpd is stupid to automate.
+
+```
+---
+ftp:
+  ldap:
+    enable: false
+    host: 'ldap.example.com'
+    port: 636
+    bind_dn: ''
+    bind_pw: ''
+    base: ''
+    filter: '(&(objectClass=posixAccount)(uid=\L))'
+  enable_pam: false
+  tls:
+    enable: false
+    cert: ''
+    key: ''
+```