File: otherapps.xml

package info (click to toggle)
kamailio 6.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 70,472 kB
  • sloc: ansic: 859,394; xml: 203,514; makefile: 9,688; sh: 9,105; sql: 8,571; yacc: 4,121; python: 3,086; perl: 2,955; java: 449; cpp: 289; javascript: 270; php: 258; ruby: 248; awk: 27
file content (134 lines) | stat: -rw-r--r-- 5,088 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<section id="otherapps" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
	<revhistory>
	    <revision>
		<revnumber>$Revision$</revnumber>
		<date>$Date$</date>
	    </revision>
	</revhistory>
    </sectioninfo>
    
    <title>Complementary Applications</title>
    <section id="serctl">
	<title><application>serctl</application> command-line tool</title>
	<para>
	    <application>serctl</application> is a command-line utility which allows to
	    perform most of management tasks needed to operate
	    <application>ser</application>: adding users, changing their passwords,
	    watching server status, etc. Usage of utility is
	    as follows:
	    <example>
		<title><application>serctl</application> usage</title>
		<programlisting>
usage: 
           * subscribers *
 serctl add &lt;username&gt; &lt;password&gt; &lt;email&gt; .. add a new subscriber (*)
 serctl passwd &lt;username&gt; &lt;passwd&gt; ......... change user's password (*)
 serctl rm &lt;username&gt; ...................... delete a user (*)
 serctl mail &lt;username&gt; .................... send an email to a user
 serctl alias show [&lt;alias&gt;] ............... show aliases
 serctl alias rm &lt;alias&gt; ................... remove an alias
 serctl alias add &lt;alias&gt; &lt;uri&gt; ............ add an alias

           * access control lists *
 serctl acl show [&lt;username&gt;] .............. show user membership
 serctl acl grant &lt;username&gt; &lt;group&gt; ....... grant user membership (*)
 serctl acl revoke &lt;username&gt; [&lt;group&gt;] .... grant user membership(s) (*)

           * usrloc *
 serctl ul show [&lt;username&gt;]................ show in-RAM online users
 serctl ul rm &lt;username&gt; ................... delete user's UsrLoc entries
 serctl ul add &lt;username&gt; &lt;uri&gt; ............ introduce a permanent UsrLoc entry
 serctl showdb [&lt;username&gt;] ................ show online users flushed in DB

           * server health *
 serctl monitor ............................ show internal status
 serctl ps ................................. show running processes 
 serctl fifo ............................... send raw commands to FIFO

   Commands labeled with (*) will prompt for a MySQL password.
   If the variable PW is set, the password will not be prompted.
		</programlisting>
	    </example>
	</para>
	<note>
	    <para>
		
		Prior to using the utility, you have to first 
		set the environment variable <constant>SIP_DOMAIN</constant>
		to locally appropriate value (e.g., "foo.com"). It is
		needed for calculation of user credentials, which depend
		    on SIP digest realm. 
		    (see also <link linkend="msmbug">MSM Authentication Issue</link>)
	        </para>
	    </note>

	    <example>
		<title>Example Output of Server Watching Command 
		    <command>sc monitor</command>
		</title>
		<programlisting>
[cycle #: 2; if constant make sure server lives and fifo is on]
Server: Sip EXpress router(0.8.8 (i386/linux))
Now: Thu Sep 26 23:16:48 2002
Up Since: Thu Sep 26 12:35:27 2002
Up time: 38481 [sec]

Transaction Statistics
Current: 0 (0 waiting) Total: 606 (0 local)       
Replied locally: 34      
Completion status 6xx: 0, 5xx: 1, 4xx: 86, 3xx: 0,2xx: 519      

Stateless Server Statistics
200: 6218 202: 0 2xx: 0      
300: 0 301: 0 302: 0 3xx: 0      
400: 0 401: 7412 403: 2 404: 1258 407: 116 408: 0 483: 0 4xx: 25      500: 0 5xx: 0      
6xx: 0      
xxx: 0      
failures: 0      

UsrLoc Stats
Domain Registered Expired
'aliases' 9 0
'location' 29 17
		</programlisting>

	    </example>
	</section>

	<section id="serweb">
	    <title>Web User Provisioning -- <application>serweb</application></title>
	    <para>
		To make provisioning of user accounts convenient, 
		a web front-end to <application>ser</application>,
		<application>serweb</application> has been
		developed. <application>serweb</application>,
		a PHP-written web application,
		allows users to apply for new <application>ser</application>
		accounts, and maintain these.
		Users can manipulate their contacts, keep a phone-book
		with SIP addresses, change password, send instant SIP messages,
		and more. Administrators can manipulate any accounts and
		grant or revoke user privileges.
	    </para>
	    <para>
		<application>serweb</application> is freely
		available from berlios site at
		<ulink url="http://developer.berlios.de/cvs/?group_id=500">
		http://developer.berlios.de/cvs/?group_id=500</ulink>. Installation
		takes unpacking tarball to a safe destination at web server
		(better not in the HTML tree) and configuring 
		<filename>config.php</filename> accordingly
		to local conditions.
	    </para>
	    <para>
		Running <application>serweb</application> can
		be seen at iptel.org's SIP site. Just create and use a SIP
		account at <ulink url="http://www.iptel.org/user/">http://www.iptel.org/user/</ulink>
	    </para>
    </section> <!-- serweb -->
</section>