Add a small documentation file about expiration
authorkkalev <kkalev>
Fri, 24 Sep 2004 12:32:29 +0000 (12:32 +0000)
committerkkalev <kkalev>
Fri, 24 Sep 2004 12:32:29 +0000 (12:32 +0000)
doc/rlm_expiration [new file with mode: 0644]

diff --git a/doc/rlm_expiration b/doc/rlm_expiration
new file mode 100644 (file)
index 0000000..f9279de
--- /dev/null
@@ -0,0 +1,23 @@
+Module to expire user accounts.
+
+This module can be used to expire user accounts. Expired users receive
+an Access-Reject on every authentication attempt. Expiration is based
+on the Expiration attribute which should be present in the check item
+list for the user we wish to perform expiration checks.
+
+
+
+Expiration attribute format:
+
+You can use Expiration := "23 Sep 2004" and the user will 
+no longer be able to connect at 00:00 (midnight) on September 23rd, 
+2004.  If you want a certain time (other than midnight) you can do 
+use  Expiration := "23 Sep 2004 12:00".
+The nas will receive a Session-Timeout attribute calculated to kick
+the user off when the Expiration time occurs.
+
+
+
+Example entry (users files):
+
+user1  Expiration := "23 Sep 2004"