- Spelling checked
[sip-router] / doc / seruser / otherapps.sgml
1     <chapter id="complementaryapps">
2         <title>Complementary Applications</title>
3         <section id="serctl">
4             <title><application>serctl</application> command-line tool</title>
5             <para>
6                 <application>serctl</application> is a command-line utility which allows to
7                 perform most of management tasks needed to operate
8                 <application moreinfo="none">ser</application>: adding users, changing their passwords,
9                 watching server status, etc. Usage of utility is
10                 as follows:
11
12                 <example>
13                     <title><application>serctl</application> usage</title>
14                     <programlisting format="linespecific">
15
16 usage: 
17            * subscribers *
18  serctl add &lt;username&gt; &lt;password&gt; &lt;email&gt; .. add a new subscriber (*)
19  serctl passwd &lt;username&gt; &lt;passwd&gt; ......... change user's password (*)
20  serctl rm &lt;username&gt; ...................... delete a user (*)
21  serctl mail &lt;username&gt; .................... send an email to a user
22  serctl alias show [&lt;alias&gt;] ............... show aliases
23  serctl alias rm &lt;alias&gt; ................... remove an alias
24  serctl alias add &lt;alias&gt; &lt;uri&gt; ............ add an aliases 
25
26            * access control lists *
27  serctl acl show [&lt;username&gt;] .............. show user membership
28  serctl acl grant &lt;username&gt; &lt;group&gt; ....... grant user membership (*)
29  serctl acl revoke &lt;username&gt; [&lt;group&gt;] .... grant user membership(s) (*)
30
31            * usrloc *
32  serctl ul show [&lt;username&gt;]................ show in-RAM online users
33  serctl ul rm &lt;username&gt; ................... delete user's UsrLoc entries
34  serctl ul add &lt;username&gt; &lt;uri&gt; ............ introduce a permanent UsrLoc entry
35  serctl showdb [&lt;username&gt;] ................ show online users flushed in DB
36
37            * server health *
38  serctl monitor ............................ show internal status
39  serctl ps ................................. show running processes 
40  serctl fifo ............................... send raw commands to FIFO
41
42    Commands labeled with (*) will prompt for a MySQL password.
43    If the variable PW is set, the password will not be prompted.
44
45  </programlisting>
46                 </example>
47             </para>
48             <note>
49                 <para>
50
51                 Prior to using the utility, you have to first 
52                 set the environment variable <constant>SIP_DOMAIN</constant>
53                 to locally appropriate value (e.g., "foo.com"). It is
54                 needed for calculation of user credentials, which depend
55                     on SIP digest realm. 
56                     (see also <link linkend="msmbug">MSM Authentication Issue</link>)
57                 </para>
58             </note>
59
60             <example>
61                 <title>Example Output of Server Watching Command 
62                     <command moreinfo="none">sc monitor</command>
63                 </title>
64                 <programlisting format="linespecific">
65
66 [cycle #: 2; if constant make sure server lives and fifo is on]
67 Server: Sip EXpress router(0.8.8 (i386/linux))
68 Now: Thu Sep 26 23:16:48 2002
69 Up Since: Thu Sep 26 12:35:27 2002
70 Up time: 38481 [sec]
71
72 Transaction Statistics
73 Current: 0 (0 waiting) Total: 606 (0 local)       
74 Replied localy: 34      
75 Completion status 6xx: 0, 5xx: 1, 4xx: 86, 3xx: 0,2xx: 519      
76
77 Stateless Server Statistics
78 200: 6218 202: 0 2xx: 0      
79 300: 0 301: 0 302: 0 3xx: 0      
80 400: 0 401: 7412 403: 2 404: 1258 407: 116 408: 0 483: 0 4xx: 25      500: 0 5xx: 0      
81 6xx: 0      
82 xxx: 0      
83 failures: 0      
84
85 UsrLoc Stats
86 Domain Registered Expired
87 'aliases' 9 0
88 'location' 29 17
89
90                 </programlisting>
91
92             </example>
93         </section>
94
95         <section id="serweb">
96             <title>Web User Provisioning -- <application>serweb</application></title>
97             <para>
98                 To make provisioning of user accounts convenient, 
99                 a web front-end to <application moreinfo="none">ser</application>,
100                 <application moreinfo="none">serweb</application> has been
101                 developed. <application moreinfo="none">serweb</application>,
102                 a PHP-written web application,
103                 allows users to apply for new <application moreinfo="none">ser</application>
104                 accounts, and maintain these.
105                 Users can manipulate their contacts, keep a phone-book
106                 with SIP addresses, change password, send instant SIP messages,
107                 and more. Administrators can manipulate any accounts and
108                 grant or revoke user privileges.
109             </para>
110             <para>
111                 <application moreinfo="none">serweb</application> is freely
112                 available from berlios site at
113                 <ulink url="http://developer.berlios.de/cvs/?group_id=500">
114                 http://developer.berlios.de/cvs/?group_id=500</ulink>. Installation
115                 takes unpacking tarball to a safe destination at web server
116                 (better not in the HTML tree) and configuring 
117                 <filename moreinfo="none">config.php</filename> accordingly
118                 to local conditions.
119             </para>
120             <para>
121                 Running <application moreinfo="none">serweb</application> can
122                 be seen at iptel.org's SIP site. Just create and use a SIP
123                 account at <ulink url="http://www.iptel.org/user/">http://www.iptel.org/user/</ulink>
124             </para>
125         </section> <!-- serweb -->
126
127
128     <section>
129         <title>Voicemail</title>
130 &voicemail;
131     </section> <!-- voicemail -->
132
133     </chapter> <!-- other apps -->