Browse code

updated documentation

git-svn-id: http://svn.berlios.de/svnroot/repos/sems/trunk@100 8eb893ce-cfd4-0310-b710-fb5ebe64c474

Stefan Sayer authored on 10/10/2006 16:10:12
Showing 2 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,57 @@
1
+compilation instructions for SEMS
2
+---------------------------------
3
+
4
+make
5
+
6
+IVR
7
+---
8
+Edit apps/ivr/Makefile.defs:
9
+
10
+1. Python version and path
11
+ set the python version (2.3, 2.4, 2.5) 
12
+ PYTHON_VERSION = 2.4
13
+ and the python path, usually /usr/local or /usr:
14
+ PYTHON_PREFIX = /usr/local
15
+
16
+2. TTS with flite speech synthesizer
17
+ To disable text-to-speech, set
18
+ TTS = n
19
+ To enable text-to-speech, set
20
+ TTS = y
21
+ and get the flite speech synthesizer from 
22
+ http://cmuflite.org/
23
+ e.g. with 
24
+  cd /usr/src ; 
25
+  wget http://www.speech.cs.cmu.edu/flite/packed/flite-1.3/flite-1.3-release.tar.gz ; 
26
+  tar xzvf flite-1.3-release.tar.gz ; cd flite-1.3-release ; 
27
+  ./configure ; make ; make install
28
+ If you do not want to do make install for flite, set
29
+  FLITE_DIR  = /path/to/flite/source
30
+ in apps/ivr/Makefile
31
+
32
+MP3 file writer
33
+---------------
34
+short: cd plug-in/mp3 ; 
35
+       wget http://switch.dl.sourceforge.net/sourceforge/lame/lame-3.96.1.tar.gz ;
36
+       tar xzvf lame-3.96.1.tar.gz ; make
37
+
38
+ 1) Get lame from lame.sourceforge.net (
39
+    http://sourceforge.net/project/showfiles.php?group_id=290)
40
+ 2) Unpack the archive
41
+ 3) edit LAME_DIR in mp3 plug-in Makefile to point to the location of
42
+    the unpacked lame source archive
43
+ 4) make in plug-in/mp3 directory
44
+
45
+ Note: Using the LAME encoding engine (or other mp3 encoding technology) in
46
+ your software may require a patent license in some countries.
47
+ See http://www.mp3licensing.com/ or
48
+ http://lame.sourceforge.net/links.html#patents for further information.
49
+ (Get seated before looking at the license prices).
50
+
51
+Excluding some modules from builing
52
+-----------------------------------
53
+
54
+Set exclude_modules in apps/Makefile to a list of the modules you 
55
+don't want to be built, e.g. if you are not using mp3 and conf_auth: 
56
+exclude_modules = mp3 conf_auth
57
+
0 58
similarity index 54%
1 59
rename from core/README
2 60
rename to README
... ...
@@ -15,51 +15,53 @@ Introduction:
15 15
 
16 16
  You can easely extend Sems by creating your own plug-ins.
17 17
 
18
- The following default modules are shipped with Sems stable version:
18
+ The following default applications are shipped with Sems :
19 19
 
20
- * Voicemail: records voice messages and mail them to the callee.
20
+ * voicemail: records voice messages and mail them to the callee.
21 21
 
22
- * ISDN Gateway: support calls from and to the PSTN.
23
-
24
- * Conferencing: enables many people to talk together
22
+ * conferencing: enables many people to talk together
25 23
                  at the same time.
26 24
 
27
- * Announcement: plays an announcement.
25
+ * announcement: plays an announcement.
26
+
27
+ * echo: test module echoing your voice.
28
+ 
29
+ * mailbox: saves voicemails into an IMAP server. Users 
30
+            can dial in to check their messages
31
+
32
+ * ann_b2b: plays ann announcement before connecting the callee
33
+            in b2bua mode
28 34
 
29
- * Number reader: reads the called number.
35
+ * conf_auth: collect a PIN number, verify it against an 
36
+              XMLRPC authentication server and connect in b2bua mode
30 37
 
31
- * Echo: test module echoing your voice.
38
+ * early_announce: announcement for early media (183)
32 39
 
33
-Some new services like IVR, Text-To-Speech, MP3 and iLBC support are only
34
-available in the developement version of Sems.
35 40
 
36
-Sems only support patent free codecs. Which means that we won't support codecs
37
-like g729. On the other hand, we have support for all important patent free
38
-(g711u, g711a, GSM06.10 and iLBC).
41
+ Sems only support patent free codecs. Which means that we won't support codecs
42
+ like g729. On the other hand, we have support for all important patent free
43
+ (g711u, g711a, GSM06.10 and iLBC).
39 44
 
40 45
 Requirements:
41 46
 
42
- 1. Ser version >= 0.8.12: SIP Epress Router (www.iptel.org/ser)
47
+ 1. Ser version 0.9.6: SIP Epress Router (www.iptel.org/ser)
43 48
 
44 49
     - Sems requires Ser as its SIP stack. 
45
-    - Sems & Ser communicate together through FIFO file, which means that a Ser
50
+    - Sems & Ser communicate together through socket, which means that a Ser
46 51
       instance is mandatory on every host using Sems.
47 52
 
53
+ 2. Python version >= 2.3 for the ivr (embedded python interpreter), optional
48 54
 
49
-Installation:
50
-
51
- 1. Download Sems through CVS:
52
-
53
-    Stable version:
55
+ 3. flite speech synthesizer for TTS in the ivr, optional
54 56
 
55
-      export CVSROOT=:pserver:anonymous@cvs.berlios.de:/cvsroot/sems
56
-      cvs co -r ser_rel_0_8_12 answer_machine
57
+ 4. lame >= 3.95 for mp3 file output, optional
57 58
 
58
-    Developement version:
59
-
60
-      export CVSROOT=:pserver:anonymous@cvs.berlios.de:/cvsroot/sems
61
-      cvs co answer_machine
59
+Installation:
62 60
 
61
+ 1. Download Sems through svn:
62
+    svn checkout svn://svn.berlios.de/sems/trunk
63
+      -or-
64
+    svn checkout http://svn.berlios.de/svnroot/repos/sems/trunk 
63 65
 
64 66
  2. Compile Sems:
65 67
 
... ...
@@ -68,13 +70,14 @@ Installation:
68 70
 
69 71
     Notice: you don't need to execute 'make install' if you want to run Sems
70 72
             from the source tree.
73
+     
74
+    For detailed instructions, have a look at COMPILING as well.
71 75
 
72
-
73
- 3. Look at the default configuration file if it fits your need:
76
+ 3. Look at the default configuration file whether it fits your need:
74 77
 
75 78
       If you installed Sems with 'make install', the configuration
76
-      is at '/etc/sems/sems.conf'. Else make your own using sems.conf.sample.
77
-
79
+      is at '/usr/local/etc/sems/sems.conf'. 
80
+      Else make your own using sems.conf.sample.
78 81
 
79 82
  4. Start Ser: 
80 83
 
... ...
@@ -103,10 +106,11 @@ Troubleshooting:
103 106
 
104 107
 Installed file using 'make install':
105 108
 
106
-    /etc/sems/sems.conf                  : configuration file.
109
+    /usr/local/etc/sems/sems.conf                  : configuration file.
107 110
     /usr/local/sbin/sems                 : Sems executable.
108 111
     /usr/local/lib/sems/plug-in/*        : plug-ins.
109 112
     /usr/local/lib/sems/audio/*          : default path for audio files.
113
+    /usr/local/lib/sems/ivr/*            : precompiled IVR scripts
110 114
     /usr/local/share/doc/sems/README     : this README.
111 115
 
112 116
     source_path/scripts/sems[.redhat]    : example start-up scripts.
... ...
@@ -116,14 +120,18 @@ Installed file using 'make install':
116 120
 Bug report & Contact:
117 121
 
118 122
   If you have problems configuring Ser&Sems for your needs,
119
-  look at the support information on the Ser homepage (www.iptel.org/ser).
120
-
123
+  look at the support information on the Ser homepage (www.iptel.org/ser)
124
+  and the SEMS hoempage (www.iptel.org/sems).
125
+  The mailing lists (http://lists.iptel.org) for SEMS are the first 
126
+  address to ask for help, report bugs and improvements.
121 127
 
122 128
 Authors:
123 129
 
124
-  Raphael Coeffic (rco@iptel.org) &
125
-  Ulrich Abend (ullstar@iptel.org).
130
+  Raphael Coeffic (rco@iptel.org), 
131
+  Ulrich Abend (ullstar@iptel.org) &
132
+  Stefan Sayer (stefan.sayer@iptego.de)
126 133
 
134
+  and all contributors.
127 135
 
128 136
 Thanks goes to:
129 137