Browse code

- updated INSTALL - make install will install also README.cfg and INSTALL - README.cfg (=the old README which disappeared after Jiri's update)

Andrei Pelinescu-Onciul authored on 26/09/2002 12:16:17
Showing 6 changed files
... ...
@@ -1,26 +1,10 @@
1 1
 $Id$
2 2
 
3
-******************************************************
4
-* Note well: ser has not been released yet. Tarballs *
5
-* available at berlios are meant for developers.     *
6
-* Stay tuned -- we will release ser shortly,         *
7
-* including RPM packages and documentation.          *
8
-*                                                    *
9
-* -Jiri, 2002-09-23                                  *
10
-******************************************************
11
-
12
-
13
-
14
-TODO
15
-  then INSTALL needs to be completely
16
-  changed
17
-
18 3
 
19 4
 Installation Notes
20 5
 
21
-Supported arhitectures: Linux/i386, Linux/armv4l, FreeBSD/i386, Solaris/sparc64,
22
-Win*/i386 (CYGWIN) - only the core
6
+Supported arhitectures: Linux/i386, Linux/armv4l, FreeBSD/i386,
7
+Solaris/sparc64, Win*/i386 (CYGWIN) - only the core
23 8
 (for other arhitectures the Makefile must be edited)
24 9
 
25 10
 There are various configuration options defined in the Makefile.
... ...
@@ -28,20 +12,27 @@ There are various configuration options defined in the Makefile.
28 12
 Requirements:
29 13
 
30 14
 
31
-- gcc >= 2.9x; 3.0.x recommended (it will work with older version but it might
32
- require some options tweaking for best performance)
15
+- gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version
16
+  but it might require some options tweaking for best performance)
33 17
 - bison or yacc (Berkley yacc)
34 18
 - flex
35
-- gmake (on Linux this is the standard "make")
19
+- GNU make (on Linux this is the standard "make", on FreeBSD and Solaris is
20
+ called "gmake")
21
+- sed and tr (used in the makefiles)
22
+- GNU tar ("gtar" on Solaris) and gzip if you want "make tar" to work
23
+- GNU install or BSD install (on Solaris "ginstall") if you want "make
24
+  install", "make bin", "make sunpkg" to work
25
+
36 26
 
37 27
 OS Notes:
38 28
 
39 29
 - FreeBSD: make sure gmake, bison & flex are installed
40
-- Solaris: as above; you can use Solaris's yacc instead of bison
41
-- Windows: it works in windows but you must install a recent cygwin version
42
-	(http://www.cygwin.com/) and also install a newer regex library version
43
-	(>=0.12). 
44
-	
30
+- Solaris: as above; you can use Solaris's yacc instead of bison. You might
31
+  need also gtar and ginstall.
32
+- Windows: it works in windows (only the core) but you must install a recent
33
+  cygwin version (http://www.cygwin.com/) and also install a newer regex
34
+  library version (>=0.12). 
35
+    
45 36
 
46 37
 
47 38
 
... ...
@@ -79,9 +70,13 @@ make exclude_modules="CVS textops" modules
79 70
 
80 71
 make static_modules=tm PROFILE=-pg all
81 72
 
82
--compile with gcc-3.0 instead of gcc
73
+-compile with gcc-3.2 instead of gcc
74
+
75
+make CC=gcc-3.2 all
83 76
 
84
-make CC=gcc-3.0 all
77
+or
78
+
79
+CC=gcc-3.2 make all
85 80
 
86 81
 
87 82
 
... ...
@@ -107,18 +102,26 @@ Make tags:
107 102
 
108 103
 make TAGS
109 104
 
110
-Create a tar.gz with the sources:
105
+Create a tar.gz with the sources (in ../):
111 106
 
112 107
 make tar
113 108
 
114
-Create a tar.gz with the binary distribution:
109
+Create a tar.gz with the binary distribution (in ../):
115 110
 
116 111
 make bin
117 112
 
118
-Create a solaris package:
113
+Create a gzipped solaris package (in ../):
119 114
 
120 115
 make sunpkg
121 116
 
117
+Create debian packages (in ../):
118
+
119
+make deb
120
+
121
+or
122
+
123
+dpkg-buildpackage
124
+
122 125
 Install:
123 126
 
124 127
 make prefix=/usr/local  install
... ...
@@ -149,20 +152,49 @@ needed for storing user credentials.)
149 152
 A) Quick Start
150 153
 ----------------------------------------------
151 154
 
152
-1) Download an RPM package from our site
153
-	http://www.iptel.org/ser/
155
+1) Download an RPM or debian package from our site
156
+    http://www.iptel.org/ser
157
+If you don't use an rpm or debian based distro, try our tar.gz'ed binaries
158
+ (ser-$(version)_$(os)_$(arch).tar.gz, e.g: ser-0.8.8_linux_i386.tar.gz).
159
+If you use Solaris 8 you can try our solaris package.
160
+
154 161
 2) install the package
155
-	rpm -i <pachage_name>
162
+RPM:
163
+    rpm -i <package_name>
164
+debian:
165
+    dpkg -i <package_name>
166
+tar.gz:
167
+    cd /; tar zxvf <package_name>_os_arch.tar.gz
168
+    (it will install in /usr/local/, and the configuration file in
169
+     /usr/local/etc/ser/ser.cfg)
170
+Solaris:
171
+    gunzip <package_name>.gz ; pkgadd -d <package_name>
172
+    
156 173
 3) start the server
157
-	/etc/init.d/ser start
174
+RPM:
175
+    /etc/init.d/ser start
176
+debian:
177
+    ser is started automatically after the install
178
+    (in case something fails you can start it wiht /etc/init.d/ser start)
179
+tar.gz:
180
+    the tar.gz does not include an init.d script, you'll have to create one of
181
+    your own or adapt one from the source distribution (debian/init.d,
182
+    rpm/ser.init.*, gentoo/ser.init)
183
+    You can start ser directly with /usr/local/sbin/ser.
184
+Solaris:
185
+    see tar.gz.
186
+    
158 187
 4) optionally, watch server's health using the
159 188
    serctl utility
160
-	- to do so, first set the environment
161
-	  variable SIP_DOMAIN to your domain 
162
-	  name, e.g., in Bourne shell, call
163
-	    export SIP_DOMAIN="foo.bar"
164
-	- run the serctl utility
165
-	    /usr/sbin/serctl moni
189
+    - to do so, first set the environment
190
+      variable SIP_DOMAIN to your domain 
191
+      name, e.g., in Bourne shell, call
192
+        export SIP_DOMAIN="foo.bar"
193
+    - run the serctl utility
194
+        /usr/sbin/serctl moni
195
+      or
196
+        /usr/local/sbin/serctl moni (if you installed from a tar.gz or solaris
197
+        package)
166 198
 5) Register with the server using your favorite
167 199
    SIP User Agent. You may want to look at configuration
168 200
    hints for use of iptel.org site at
... ...
@@ -189,10 +221,15 @@ you need to make sure MySQL is installed on
189 221
 your box.
190 222
 
191 223
 
192
-1) Download an RPM *source* package from our site
193
-	http://www.iptel.org/ser/
224
+1) Download the package containing the ser mysql module from: 
225
+    http://www.iptel.org/ser/
226
+    (rpm and deb provided, the binary tar.gz distribution and the solaris
227
+    package do not include it, if you use them you'll have to rebuild from the
228
+    source).
194 229
 2) install the package
195
-	rpm -i <pachage_name>
230
+    rpm -i <package_name>
231
+    or
232
+    dpkg -i <package_name>
196 233
 3) create MySQL tables
197 234
     /usr/sbin/ser_mysql.sh create
198 235
 4) configure ser to use SQL
... ...
@@ -207,8 +244,8 @@ your box.
207 244
         www_challenge("iptel.org", "0"); 
208 245
         break;
209 246
       };
210
-5) start the server
211
-	/etc/init.d/ser start
247
+5) restart the server
248
+    /etc/init.d/ser restart
212 249
 6) you can now start  managing the server using
213 250
    the serctl utility; you need to first set the
214 251
    environment variable SIP_DOMAIN to your local
... ...
@@ -178,6 +178,8 @@ install-modules: modules $(modules-prefix)/$(modules-dir)
178 178
 
179 179
 install-doc: $(doc-prefix)/$(doc-dir)
180 180
 	$(INSTALL-DOC) README $(doc-prefix)/$(doc-dir)
181
+	$(INSTALL-DOC) README.cfg $(doc-prefix)/$(doc-dir)
182
+	$(INSTALL-DOC) INSTALL $(doc-prefix)/$(doc-dir)
181 183
 
182 184
 install-man: $(man-prefix)/$(man-dir)/man8 $(man-prefix)/$(man-dir)/man5
183 185
 	$(INSTALL-MAN)  ser.8 $(man-prefix)/$(man-dir)/man8
... ...
@@ -134,6 +134,7 @@ DEFS+= -DNAME='"$(NAME)"' -DVERSION='"$(RELEASE)"' -DARCH='"$(ARCH)"' \
134 134
 	 -DDNS_IP_HACK \
135 135
 	 -DUSE_IPV6 \
136 136
 	 -DF_MALLOC \
137
+	 -DEXTRA_DEBUG \
137 138
 	 #-DDBG_QM_MALLOC \
138 139
 	 #-DVQ_MALLOC  
139 140
 	 #-DCONTACT_BUG
140 141
new file mode 100644
... ...
@@ -0,0 +1,66 @@
1
+$Id$
2
+
3
+[ under construction :) ]
4
+
5
+Sources:
6
+
7
+ - set your tab stop to 4 (in vi: set ts=4).
8
+
9
+
10
+Compile & Install:
11
+
12
+- read INSTALL
13
+- compile & sip_router -h
14
+
15
+
16
+Configuration files:
17
+
18
+	Example configuration files in ./tests/*.cfg
19
+
20
+	Global parameters:
21
+		- debug
22
+		- listen
23
+		- alias
24
+		- port
25
+		- fork
26
+		- children_no
27
+		- log_stderror
28
+		- fifo
29
+		- loadmodule "path/modulename"
30
+		...
31
+
32
+	Logical expressions [missing]
33
+		Operators:
34
+			==
35
+			=~
36
+			and/&
37
+			or/|
38
+			not/!
39
+		Lvalues:
40
+			- uri
41
+			- method
42
+			- src_ip
43
+			- dst_ip
44
+			- myself
45
+		Rvalues:
46
+			- string
47
+			- integer
48
+			- ipv4 or ipv6 address
49
+			- netv4 or netv6 address
50
+			- myself (matches any uri or ip address the server listens on or 
51
+			 registered as an alias for the server)
52
+			
53
+	Commands:
54
+		- forward
55
+		- send
56
+		- error [not implemented yet ]
57
+		- log
58
+		- exec
59
+		- route/goto
60
+		- drop/break
61
+		- if {} else{}
62
+	Modules:
63
+		- loadmodule "..."
64
+		- commands registered by modules
65
+
66
+
... ...
@@ -1,4 +1,5 @@
1
-<!DOCTYPE Book SYSTEM "/usr/share/sgml/docbook/dtd-4.2/docbook.dtd">
1
+<!-- $Id$ -->
2
+<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
2 3
 
3 4
 <book label="seruser" id="seruser" lang="EN">
4 5
 <?dbhtml filename="index.html">
... ...
@@ -64,7 +65,53 @@
64 65
     
65 66
     <toc></toc>
66 67
     
67
-    <chapter id="general">
	<title>General Information</title>
	<para>
	<section id="about_ser">
	    <title>About SIP Express Router (ser)</title>
	    <para>
 SIP Express Router (SER) is an industrial-strength, free VoIP 
server based on the session initiation protocol (SIP RFC2543-bis). 
It is engineered to power IP telephony infrastructures up to large 
scale. The server keeps track of users, sets up VoIP sessions, 
relays instant messages and creates space for new plug-in applications. 
Its proven interoperability guarantees seamless integration with 
components from other vendors, eliminating the risk of a single-vendor 
trap. It has successfully participated in various interoperability 
tests in which it worked with the products of other leading SIP vendors.
	    </para>
	    <para>
The SIP Express Router enables a flexible plug-in model for new 
applications: Third parties can easily link their plug-ins with 
the server code and provide thereby advanced and customized services. 
In this way, plug-ins such as SNMP support, RADIUS accounting,
or SMS gateway have already been developed and are provided as 
advanced features. Other modules are underway: Presence server,
firewall control, and more.

	    </para>
	    <para>
Its performance and robustness allows it to serve millions of users and accommodate needs of very large operators. With a $3000 dual-CPU, the 
SIP Express Router is able to power IP telephony services in an area 
as large as the Bay Area during peak hours. Even on an IPAQ PDA, the server 
withstands 150 calls per second (CPS)! The server has been powering our 
iptel.org free SIP site withstanding heavy daily load that is further 
increasing with the popularity of Microsoft's Messenger.  
	
	    </para>
	    <para>
The SIP Express Router is extremely configurable to allow the creation of 
various routing and admission policies as well as setting up new and 
customized services. Its configurability allows it to serve many roles: 
network security barrier, application server, or PSTN gateway guard for 
example.
		</para>

	    
	</section> 

	<section id="about_iptel">
68
+    <chapter id="general">
69
+	<title>General Information</title>
70
+	<para>
71
+	<section id="about_ser">
72
+	    <title>About SIP Express Router (ser)</title>
73
+	    <para>
74
+ SIP Express Router (SER) is an industrial-strength, free VoIP 
75
+server based on the session initiation protocol (SIP RFC2543-bis). 
76
+It is engineered to power IP telephony infrastructures up to large 
77
+scale. The server keeps track of users, sets up VoIP sessions, 
78
+relays instant messages and creates space for new plug-in applications. 
79
+Its proven interoperability guarantees seamless integration with 
80
+components from other vendors, eliminating the risk of a single-vendor 
81
+trap. It has successfully participated in various interoperability 
82
+tests in which it worked with the products of other leading SIP vendors.
83
+	    </para>
84
+	    <para>
85
+The SIP Express Router enables a flexible plug-in model for new 
86
+applications: Third parties can easily link their plug-ins with 
87
+the server code and provide thereby advanced and customized services. 
88
+In this way, plug-ins such as SNMP support, RADIUS accounting,
89
+or SMS gateway have already been developed and are provided as 
90
+advanced features. Other modules are underway: Presence server,
91
+firewall control, and more.
92
+
93
+	    </para>
94
+	    <para>
95
+Its performance and robustness allows it to serve millions of users and accommodate needs of very large operators. With a $3000 dual-CPU, the 
96
+SIP Express Router is able to power IP telephony services in an area 
97
+as large as the Bay Area during peak hours. Even on an IPAQ PDA, the server 
98
+withstands 150 calls per second (CPS)! The server has been powering our 
99
+iptel.org free SIP site withstanding heavy daily load that is further 
100
+increasing with the popularity of Microsoft's Messenger.  
101
+	
102
+	    </para>
103
+	    <para>
104
+The SIP Express Router is extremely configurable to allow the creation of 
105
+various routing and admission policies as well as setting up new and 
106
+customized services. Its configurability allows it to serve many roles: 
107
+network security barrier, application server, or PSTN gateway guard for 
108
+example.
109
+		</para>
110
+
111
+	    
112
+	</section> 
113
+
114
+	<section id="about_iptel">
68 115
 	    <title>About iptel.org</title>
69 116
 	    <para>
70 117
 		iptel.org is a know-how company spun off from Germany's national 
... ...
@@ -130,7 +177,7 @@ SIP Express Router has been engineered to power large scale networks: its capaci
130 177
 		    Replacing a traditional PBX in an enterprise can achieve reasonable savings. Enterprises can deploy a single infrastructure for both voice and data and bridge distant locations over the Internet. Additionally, they can benefit of integration of voice and data.
131 178
 		</para>
132 179
 		<para>
133
-		    The SIP Express Router scales from SOHOs to large, international enterprises. Even a single installation on a common PC is able to serve VoIP signaling of any world’s enterprise.  Its policy-based routing language makes implementation of numbering plans of companies spread across the world very easy. ACL features allow for protection of PSTN gateway from unauthorized callers.
180
+		    The SIP Express Router scales from SOHOs to large, international enterprises. Even a single installation on a common PC is able to serve VoIP signaling of any world’s enterprise.  Its policy-based routing language makes implementation of numbering plans of companies spread across the world very easy. ACL features allow for protection of PSTN gateway from unauthorized callers.
134 181
 		</para>
135 182
 		<para>
136 183
 		    SIP Express Router’s support for programmable routing and accounting efficiently allows for implementation of such a scenario.
... ...
@@ -21,7 +21,7 @@ or enclosed in
21 21
 are interpreted as comments.
22 22
 .PP
23 23
 This manual page is incomplete. For further information please read
24
-.I /usr/share/doc/ser/README.
24
+.I /usr/share/doc/ser/README.cfg.
25 25
 
26 26
 .SH FILES
27 27
 .bL