*** empty log message ***

[freeside.git] / htdocs / docs / session.html

diff --git a/htdocs/docs/session.html b/htdocs/docs/session.html
index b7939ac..ed7b2ea 100644 (file)
--- a/htdocs/docs/session.html
+++ b/htdocs/docs/session.html
@@ -25,7 +25,6 @@ Then:
 </ul>
 <h2>Usage</h2>
 <ul>
-  <li>RADIUS
   <li>Web
     <ul>
       <li>Copy FS-SessionClient/cgi/login.cgi and logout.cgi to your web
@@ -33,16 +32,23 @@ Then:
       <li>Use <a href="http://www.apache.org/docs/suexec.html">suEXEC</a> or <a href="http://www.perl.com/CPAN-local/doc/manual/html/pod/perlsec.html#Security_Bugs">setuid</a> (see <a href="install.html">install.html</a> for details) to run login.cgi and logout.cgi as the freeside user.
     </ul>
   <li>Command-line
-    <br><pre>freeside-login username ( portnum | ip | nasnum nasport )</pre>
+    <br><pre>freeside-login username ( portnum | ip | nasnum nasport )
+freeside-logout username ( portnum | ip | nasnum nasport )</pre>
     <ul>
       <li><i>username</i> is a customer username from the svc_acct table
       <li><i>portnum</i>, <i>ip</i> or <i>nasport</i> and <i>nasnum</i> uniquely identify a port in the <a href="schema.html#port">port</a> database table.
     </ul>
+  <li>RADIUS
+    <ul>
+      <li>Configure your RADIUS server's login and logout callbacks to use the command-line freeside-login and freeside-logout utilites.
+    </ul>
+</ul>
+<h2>Callbacks</h2>
+<ul>
+  <li>Sesstion start - The command(s) specified in the <a href="config.html#session-start">session-start</a> configuration file are executed on the Freeside machine.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.
+  <li>Session end - The command(s) specified in the <a href="config.html#session-stop">session-stop</a> configuration file are executed on the Freeside machine.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.
 </ul>
+<h2>Dropping expired users</h2>
+Run <pre>bin/freeside-session-kill username</pre> periodically from cron.
 </body>
-
-
-
-
-
-
+</html>