1 files changed, 23 insertions, 0 deletions
diff --git a/roles/freeradius/README.md b/roles/freeradius/README.md
new file mode 100644
index 0000000..8b67265
--- /dev/null
+++ b/roles/freeradius/README.md
@@ -0,0 +1,23 @@
+# freeradius
+
+freeradius with LDAP backend
+
+```yaml
+---
+radius:
+  ldap:
+    server: 'ldap://ldap.example.com'
+    bind_user: 'uid=user,dc=example,dc=com'
+    bind_pwd: 'Password'
+    user_base: 'ou=users,dc=example,dc=com'
+    user_filter: '(uid=%{User-Name})'
+  clients:
+    - name: example
+      ip: '1.1.1.1'
+      secret: 'supersecret'
+  cert:
+    privkey: '/etc/ssl/private/ssl-cert-snakeoil.key'
+    cert: '/etc/ssl/certs/ssl-cert-snakeoil.pem'
+    ca: '/etc/ssl/certs/ca-certificates.crt'
+
+```