summaryrefslogtreecommitdiffstats
path: root/src/modules/rlm_passwd/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/rlm_passwd/README.md')
-rw-r--r--src/modules/rlm_passwd/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/modules/rlm_passwd/README.md b/src/modules/rlm_passwd/README.md
new file mode 100644
index 0000000..65c87d1
--- /dev/null
+++ b/src/modules/rlm_passwd/README.md
@@ -0,0 +1,15 @@
+# rlm_passwd
+## Metadata
+<dl>
+ <dt>category</dt><dd>datastore</dd>
+</dl>
+
+## Summary
+
+Reads and caches line-oriented files that are in a format similar
+to `/etc/passwd`.
+
+It assumes that each line is composed of a series of records,
+separated by a delimiter. The records are read from the file,
+cached, then retrieved during request processing and inserted into
+the request.