... | ... |
@@ -1,6 +1,6 @@ |
1 | 1 |
<!-- $Id$ --> |
2 | 2 |
<!-- DOCTYPE Book SYSTEM "/usr/share/sgml/docbook/dtd-4.2/docbook.dtd" [ --> |
3 |
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ |
|
3 |
+<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
|
4 | 4 |
|
5 | 5 |
|
6 | 6 |
<!ENTITY execexample SYSTEM "../../examples/exec.cfg"> |
... | ... |
@@ -4602,10 +4602,10 @@ Domain Registered Expired |
4602 | 4602 |
|
4603 | 4603 |
<itemizedlist id="routeblocks"> |
4604 | 4604 |
<title>Route Blocks and Process Control</title> |
4605 |
- <para> |
|
4605 |
+ <!--<para> |
|
4606 | 4606 |
Route block and process control keywords determine |
4607 | 4607 |
the order in which SIP requests are processed. |
4608 |
- </para> |
|
4608 |
+ </para>--> |
|
4609 | 4609 |
<listitem> |
4610 | 4610 |
<para> |
4611 | 4611 |
<command>route[number]{...}</command> - This marks a "route block" in configuration files. |
... | ... |
@@ -1,3 +1,6 @@ |
1 |
+<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ ]> |
|
2 |
+<section> |
|
3 |
+<title>Introduction</title> |
|
1 | 4 |
<para> |
2 | 5 |
The voicemail system provides <application>ser</application> |
3 | 6 |
with voice announcement and recording capabilities. Voice |
... | ... |
@@ -8,127 +11,160 @@ |
8 | 11 |
handling as described in RFC 3264 (An Offer/Answer Model with |
9 | 12 |
the Session Description Protocol) and RFC 1889 (Real time |
10 | 13 |
transport protocol) to realize its goal. |
11 |
- |
|
12 | 14 |
</para> |
15 |
+</section> |
|
13 | 16 |
<section> |
17 |
+ |
|
14 | 18 |
<title>Advantages</title> |
15 |
- <para> |
|
16 |
- Anyone deploying <application>ser</application> and |
|
17 |
- <acronym>VoIP</acronym> should profit from this 'ready-to-run' |
|
18 |
- application. It plugs into <application>ser</application> as |
|
19 |
- easy as configuring the database location, announce file path |
|
20 |
- and SMTP server address. |
|
21 |
- </para> |
|
22 |
- <para> |
|
23 |
- Further, |
|
24 |
- <application>voicemail</application> |
|
25 |
- integrates the most popular free codecs |
|
26 |
- (G.711ulaw, G.711alaw and GSM 06.10) and |
|
27 |
- its own SMTP client, which means that you |
|
28 |
- don't need to install anything else as |
|
29 |
- <application>ser</application> and |
|
30 |
- <application>voicemail</application>. |
|
31 |
- </para> |
|
32 |
- <para> |
|
33 |
- If you want your voicemail system to support |
|
34 |
- other codecs, a simple plugin system with |
|
35 |
- SDK alows you to integrate them fast and |
|
36 |
- simply (see the basis plugins for examples). |
|
37 |
- </para> |
|
19 |
+<para> |
|
20 |
+ <itemizedlist> |
|
21 |
+ <listitem> |
|
22 |
+ <para> |
|
23 |
+ Anyone deploying <application>ser</application> and |
|
24 |
+ <acronym>VoIP</acronym> should profit from this 'ready-to-run' |
|
25 |
+ application. It plugs into <application>ser</application> as |
|
26 |
+ easy as configuring the database location, announce file path |
|
27 |
+ and SMTP server address. |
|
28 |
+ </para> |
|
29 |
+ </listitem> |
|
30 |
+ <listitem> |
|
31 |
+ <para> |
|
32 |
+ Further, |
|
33 |
+ <application>voicemail</application> |
|
34 |
+ integrates the most popular free codecs |
|
35 |
+ (G.711ulaw, G.711alaw and GSM 06.10) and |
|
36 |
+ its own SMTP client, which means that you |
|
37 |
+ don't need to install anything else as |
|
38 |
+ <application>ser</application> and |
|
39 |
+ <application>voicemail</application>. |
|
40 |
+ </para> |
|
41 |
+ </listitem> |
|
42 |
+ <listitem> |
|
43 |
+ <para> |
|
44 |
+ If you want your voicemail system to support |
|
45 |
+ other codecs, a simple plugin system with |
|
46 |
+ SDK alows you to integrate them fast and |
|
47 |
+ simply (see the basis plugins for examples). |
|
48 |
+ </para> |
|
49 |
+ </listitem> |
|
50 |
+ </itemizedlist> |
|
51 |
+</para> |
|
38 | 52 |
</section> |
39 | 53 |
<section> |
54 |
+ |
|
40 | 55 |
<title>Technical limitations</title> |
41 |
- <para> |
|
42 |
- The sound conversion engine doesn't |
|
43 |
- support yet resampling. It means that |
|
44 |
- input and output files have to be |
|
45 |
- compatible with the sampling rate of the |
|
46 |
- codec. All codecs included with the |
|
47 |
- distribution work at 8kHz, which means |
|
48 |
- that all the input and output files MUST |
|
49 |
- be sampled at the rate of 8kHz. |
|
50 |
- </para> |
|
51 |
- <para> |
|
52 |
- At the moment, voicemail only support the |
|
53 |
- Microsoft Wav file format with PCM 16 bit, |
|
54 |
- Mu-law and A-law 8 bit encoding. |
|
55 |
- </para> |
|
56 |
+<para> |
|
57 |
+ <itemizedlist> |
|
58 |
+ <listitem> |
|
59 |
+ <para> |
|
60 |
+ The sound conversion engine doesn't |
|
61 |
+ support yet resampling. It means that |
|
62 |
+ input and ouput files have to be |
|
63 |
+ compatible with the sampling rate of the |
|
64 |
+ codec. All codecs included with the |
|
65 |
+ distribution work at 8kHz, which means |
|
66 |
+ that all the input and output files MUST |
|
67 |
+ be sampled at the rate of 8kHz. |
|
68 |
+ </para> |
|
69 |
+ </listitem> |
|
70 |
+ <listitem> |
|
71 |
+ <para> |
|
72 |
+ At the moment, voicemail only support the |
|
73 |
+ Microsoft Wav file format with PCM 16 bit, |
|
74 |
+ Mu-law and A-law 8 bit encoding. |
|
75 |
+ </para> |
|
76 |
+ </listitem> |
|
77 |
+ </itemizedlist> |
|
78 |
+</para> |
|
56 | 79 |
</section> |
80 |
+<section> |
|
57 | 81 |
|
82 |
+<title>Compilation and installation</title> |
|
83 |
+<para> |
|
84 |
+ <itemizedlist> |
|
85 |
+ <listitem> |
|
86 |
+ <para> |
|
87 |
+ First, you need to compile Ser with voicemail |
|
88 |
+ support. Thatfor, you must edit Ser's |
|
89 |
+ Makefile.defs file and uncomment the line with |
|
90 |
+ '-DVOICE_MAIL' and '-D_TOTAG'. |
|
91 |
+ </para> |
|
92 |
+ </listitem> |
|
93 |
+ <listitem> |
|
94 |
+ <para> |
|
95 |
+ Then do 'make all' in Ser's root directory. |
|
96 |
+ </para> |
|
97 |
+ </listitem> |
|
98 |
+ <listitem> |
|
99 |
+ <para> |
|
100 |
+ Configure Ser to fit your needs. You can |
|
101 |
+ report to voicemail example config file to |
|
102 |
+ know what your configuration file should |
|
103 |
+ include. Note that voicemail |
|
104 |
+ only needs to know the user database location |
|
105 |
+ in order to work. Report to the README file in |
|
106 |
+ the vm module directory for description of the |
|
107 |
+ functions and variable that are used by |
|
108 |
+ voicemail and how they work. |
|
109 |
+ </para> |
|
110 |
+ </listitem> |
|
111 |
+ <listitem> |
|
112 |
+ <para> |
|
113 |
+ Finally, compile the voicemail application: |
|
114 |
+ |
|
115 |
+ <programlisting> |
|
116 |
+ [~/voicemail]$ cd ortp-0.5.0 |
|
117 |
+ [~/voicemail/ortp-0.5.0]$ ./configure |
|
118 |
+ [~/voicemail/ortp-0.5.0]$ make all |
|
119 |
+ [~/voicemail/ortp-0.5.0]$ cd .. |
|
120 |
+ [~/voicemail]$ cd plug-in/gsm/gsm-???? |
|
121 |
+ [~/voicemail/plug-in/gsm/gsm-????]$ make all |
|
122 |
+ [~/voicemail/plug-in/gsm/gsm-????]$ cd ../.. |
|
123 |
+ [~/voicemail]$ make all |
|
124 |
+ </programlisting> |
|
125 |
+ |
|
126 |
+ You can then start voicemail with following |
|
127 |
+ command <command>ans_machine</command> and |
|
128 |
+ look if the default fit your needs. If not, |
|
129 |
+ type <command>ans_machine -h</command> to see |
|
130 |
+ how to change the default parameters. |
|
131 |
+ |
|
132 |
+ <!--<note>--> |
|
133 |
+ If <application>ans_machine</application> is |
|
134 |
+ not started or can't be joined while |
|
135 |
+ <application>ser</application> tries to |
|
136 |
+ communicate with it, the caller will become |
|
137 |
+ a '500 internal server error' with a comment |
|
138 |
+ saying what the trouble is. |
|
139 |
+ <!--</note>--> |
|
140 |
+ </para> |
|
141 |
+ </listitem> |
|
142 |
+ </itemizedlist> |
|
143 |
+</para> |
|
144 |
+</section> |
|
58 | 145 |
|
59 | 146 |
<section> |
60 |
-<title>Compilation and installation</title> |
|
61 |
- <para> |
|
62 |
- First, you need to compile Ser with voicemail |
|
63 |
- support. Therefore, you must edit Ser's |
|
64 |
- Makefile.defs file and uncomment the line with |
|
65 |
- '-DVOICE_MAIL' and '-D_TOTAG'. |
|
66 |
- </para> |
|
67 |
- <para> |
|
68 |
- Then do 'make all' in Ser's root directory. |
|
69 |
- </para> |
|
70 |
- <para> |
|
71 |
- Configure Ser to fit your needs. You can |
|
72 |
- report to voicemail example config file to |
|
73 |
- know what your configuration file should |
|
74 |
- include. Note that voicemail |
|
75 |
- only needs to know the user database location |
|
76 |
- in order to work. Report to the README file in |
|
77 |
- the vm module directory for description of the |
|
78 |
- functions and variable that are used by |
|
79 |
- voicemail and how they work. |
|
80 |
- </para> |
|
81 |
- <para> |
|
82 |
- Finally, compile the voicemail application: |
|
83 |
- </para> |
|
84 |
- <para> |
|
85 |
- <programlisting> |
|
86 |
- [~/voicemail]$ cd ortp-0.5.0 |
|
87 |
- [~/voicemail/ortp-0.5.0]$ ./configure |
|
88 |
- [~/voicemail/ortp-0.5.0]$ make all |
|
89 |
- [~/voicemail/ortp-0.5.0]$ cd .. |
|
90 |
- [~/voicemail]$ cd plug-in/gsm/gsm-???? |
|
91 |
- [~/voicemail/plug-in/gsm/gsm-????]$ make all |
|
92 |
- [~/voicemail/plug-in/gsm/gsm-????]$ cd ../.. |
|
93 |
- [~/voicemail]$ make all |
|
94 |
- </programlisting> |
|
95 |
- </para> |
|
96 |
- <para> |
|
97 |
- You can then start voicemail with following |
|
98 |
- command <command>ans_machine</command> and |
|
99 |
- look if the default fit your needs. If not, |
|
100 |
- type <command>ans_machine -h</command> to see |
|
101 |
- how to change the default parameters. |
|
102 |
- </para> |
|
103 |
- <para> |
|
104 |
- If <application>ans_machine</application> is |
|
105 |
- not started or can't be joined while |
|
106 |
- <application>ser</application> tries to |
|
107 |
- communicate with it, the caller will become |
|
108 |
- a '500 internal server error' with a comment |
|
109 |
- saying what the trouble is. |
|
110 |
- </para> |
|
147 |
+<title>Example ser Config File</title> |
|
148 |
+<para> |
|
111 | 149 |
<example> |
112 | 150 |
<title>Example ser Config File</title> |
113 | 151 |
<programlisting> |
114 | 152 |
&voicemailcfg; |
115 | 153 |
</programlisting> |
116 | 154 |
</example> |
155 |
+</para> |
|
117 | 156 |
</section> |
118 | 157 |
<section> |
119 |
-<title>Availability, report bugs, contact the author</title> |
|
120 |
-<para> |
|
121 |
- Ser's Voicemail is hosted at |
|
122 |
- <ulink |
|
123 |
- url="http://developer.berlios.de/projects/sems">http://developer.berlios.de/projects/sems</ulink>. |
|
124 |
- A snapshot may be downloaded directly from the CVS tree. A |
|
125 |
- pre-configured version of <application>ser</application> |
|
126 |
- including <application>voicemail</application> will be soon |
|
127 |
- available (starting from version 0.8.11). |
|
128 |
-</para> |
|
158 |
+ |
|
159 |
+<title>Availabilty, report bugs, contact the author</title> |
|
129 | 160 |
<para> |
130 |
- Bugs can be directly reported at the voicemail's project page. If you |
|
131 |
- want to contact the author, use the contact email at the |
|
132 |
- project's web page. |
|
161 |
+ Ser's Voicemail's home page is hosted at |
|
162 |
+ http://sems.berlios.de. A snapshot may be downloaded directly |
|
163 |
+ from the CVS tree. A pre-configured version of |
|
164 |
+ <application>ser</application> including |
|
165 |
+ <application>voicemail</application> will be soon available |
|
166 |
+ (from version 0.8.11). Bugs can be reported at the voicemail's |
|
167 |
+ home page. If you want to contact the author, use the contact |
|
168 |
+ email at the home page. |
|
133 | 169 |
</para> |
134 | 170 |
</section> |