161be9846528c79f1b72714e01df70950b2a8044
[freeside.git] / htdocs / docs / session.html
1 <head>
2   <title>Session monitor</title>
3 </head>
4 <body>
5 <h1>Session monitor</h1>
6 <h2>Installation</h2>
7 For security reasons, the client portion of the session montior may run on an
8 external public machine.  On this machine, install:
9 <ul>
10   <li><a href="http://www.perl.com/CPAN/doc/relinfo/INSTALL.html">Perl</a> (at l
11 east 5.004_05 for the 5.004 series or 5.005_03 for the 5.005 series.  Don't enab
12 le experimental features like threads or the PerlIO abstraction layer.)
13   <li><a href="man/FS/SessionClient.html">FS::SessionClient</a> (copy the fs_session/FS-SessionClient directory to the external machine, then: perl Makefile.PL; make; make install)
14 </ul>
15 Then:
16 <ul>
17   <li>Add the user `freeside' to the the external machine.
18   <li>Create the /usr/local/freeside directory on the external machine (owned by the freeside user).
19   <li>touch /usr/local/freeside/fs_sessiond_socket; chown freeside /usr/local/freeside/fs_sessiond_socket; chmod 600 /usr/local/freeside/fs_sessiond_socket
20     <li>Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the external machine(s).
21   <li>Run <pre>fs_session_server <i>user</i> <i>machine</i></pre> on the Freeside machine.
22   <ul>
23     <li><i>user</i> is a user from the mapsecrets file.
24     <li><i>machine</i> is the name of the external machine.
25   </ul>
26 </ul>
27 <h2>Usage</h2>
28 <ul>
29   <li>RADIUS
30   <li>Web
31   <li>Command-line
32     <br><pre>freeside-login username ( portnum | ip | nasnum nasport )</pre>
33     <ul>
34       <li><i>username</i> is a customer username from the svc_acct table
35       <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.
36     </ul>
37 </ul>
38 </body>
39
40
41
42
43
44