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 28
 Requirements:
29 29
 
30 30
 
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)
31
+- gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version
32
+  but it might require some options tweaking for best performance)
33 33
 - bison or yacc (Berkley yacc)
34 34
 - flex
35
-- gmake (on Linux this is the standard "make")
35
+- GNU make (on Linux this is the standard "make", on FreeBSD and Solaris is
36
+ called "gmake")
37
+- sed and tr (used in the makefiles)
38
+- GNU tar ("gtar" on Solaris) and gzip if you want "make tar" to work
39
+- GNU install or BSD install (on Solaris "ginstall") if you want "make
40
+  install", "make bin", "make sunpkg" to work
41
+
36 42
 
37 43
 OS Notes:
38 44
 
39 45
 - 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
-	
46
+- Solaris: as above; you can use Solaris's yacc instead of bison. You might
47
+  need also gtar and ginstall.
48
+- Windows: it works in windows (only the core) but you must install a recent
49
+  cygwin version (http://www.cygwin.com/) and also install a newer regex
50
+  library version (>=0.12). 
51
+    
45 52
 
46 53
 
47 54
 
... ...
@@ -79,9 +70,13 @@ make exclude_modules="CVS textops" modules
79 79
 
80 80
 make static_modules=tm PROFILE=-pg all
81 81
 
82
--compile with gcc-3.0 instead of gcc
82
+-compile with gcc-3.2 instead of gcc
83
+
84
+make CC=gcc-3.2 all
83 85
 
84
-make CC=gcc-3.0 all
86
+or
87
+
88
+CC=gcc-3.2 make all
85 89
 
86 90
 
87 91
 
... ...
@@ -107,18 +102,26 @@ Make tags:
107 107
 
108 108
 make TAGS
109 109
 
110
-Create a tar.gz with the sources:
110
+Create a tar.gz with the sources (in ../):
111 111
 
112 112
 make tar
113 113
 
114
-Create a tar.gz with the binary distribution:
114
+Create a tar.gz with the binary distribution (in ../):
115 115
 
116 116
 make bin
117 117
 
118
-Create a solaris package:
118
+Create a gzipped solaris package (in ../):
119 119
 
120 120
 make sunpkg
121 121
 
122
+Create debian packages (in ../):
123
+
124
+make deb
125
+
126
+or
127
+
128
+dpkg-buildpackage
129
+
122 130
 Install:
123 131
 
124 132
 make prefix=/usr/local  install
... ...
@@ -149,20 +152,49 @@ needed for storing user credentials.)
149 149
 A) Quick Start
150 150
 ----------------------------------------------
151 151
 
152
-1) Download an RPM package from our site
153
-	http://www.iptel.org/ser/
152
+1) Download an RPM or debian package from our site
153
+    http://www.iptel.org/ser
154
+If you don't use an rpm or debian based distro, try our tar.gz'ed binaries
155
+ (ser-$(version)_$(os)_$(arch).tar.gz, e.g: ser-0.8.8_linux_i386.tar.gz).
156
+If you use Solaris 8 you can try our solaris package.
157
+
154 158
 2) install the package
155
-	rpm -i <pachage_name>
159
+RPM:
160
+    rpm -i <package_name>
161
+debian:
162
+    dpkg -i <package_name>
163
+tar.gz:
164
+    cd /; tar zxvf <package_name>_os_arch.tar.gz
165
+    (it will install in /usr/local/, and the configuration file in
166
+     /usr/local/etc/ser/ser.cfg)
167
+Solaris:
168
+    gunzip <package_name>.gz ; pkgadd -d <package_name>
169
+    
156 170
 3) start the server
157
-	/etc/init.d/ser start
171
+RPM:
172
+    /etc/init.d/ser start
173
+debian:
174
+    ser is started automatically after the install
175
+    (in case something fails you can start it wiht /etc/init.d/ser start)
176
+tar.gz:
177
+    the tar.gz does not include an init.d script, you'll have to create one of
178
+    your own or adapt one from the source distribution (debian/init.d,
179
+    rpm/ser.init.*, gentoo/ser.init)
180
+    You can start ser directly with /usr/local/sbin/ser.
181
+Solaris:
182
+    see tar.gz.
183
+    
158 184
 4) optionally, watch server's health using the
159 185
    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
186
+    - to do so, first set the environment
187
+      variable SIP_DOMAIN to your domain 
188
+      name, e.g., in Bourne shell, call
189
+        export SIP_DOMAIN="foo.bar"
190
+    - run the serctl utility
191
+        /usr/sbin/serctl moni
192
+      or
193
+        /usr/local/sbin/serctl moni (if you installed from a tar.gz or solaris
194
+        package)
166 195
 5) Register with the server using your favorite
167 196
    SIP User Agent. You may want to look at configuration
168 197
    hints for use of iptel.org site at
... ...
@@ -189,10 +221,15 @@ you need to make sure MySQL is installed on
189 189
 your box.
190 190
 
191 191
 
192
-1) Download an RPM *source* package from our site
193
-	http://www.iptel.org/ser/
192
+1) Download the package containing the ser mysql module from: 
193
+    http://www.iptel.org/ser/
194
+    (rpm and deb provided, the binary tar.gz distribution and the solaris
195
+    package do not include it, if you use them you'll have to rebuild from the
196
+    source).
194 197
 2) install the package
195
-	rpm -i <pachage_name>
198
+    rpm -i <package_name>
199
+    or
200
+    dpkg -i <package_name>
196 201
 3) create MySQL tables
197 202
     /usr/sbin/ser_mysql.sh create
198 203
 4) configure ser to use SQL
... ...
@@ -207,8 +244,8 @@ your box.
207 207
         www_challenge("iptel.org", "0"); 
208 208
         break;
209 209
       };
210
-5) start the server
211
-	/etc/init.d/ser start
210
+5) restart the server
211
+    /etc/init.d/ser restart
212 212
 6) you can now start  managing the server using
213 213
    the serctl utility; you need to first set the
214 214
    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 @@
0
+$Id$
1
+
2
+[ under construction :) ]
3
+
4
+Sources:
5
+
6
+ - set your tab stop to 4 (in vi: set ts=4).
7
+
8
+
9
+Compile & Install:
10
+
11
+- read INSTALL
12
+- compile & sip_router -h
13
+
14
+
15
+Configuration files:
16
+
17
+	Example configuration files in ./tests/*.cfg
18
+
19
+	Global parameters:
20
+		- debug
21
+		- listen
22
+		- alias
23
+		- port
24
+		- fork
25
+		- children_no
26
+		- log_stderror
27
+		- fifo
28
+		- loadmodule "path/modulename"
29
+		...
30
+
31
+	Logical expressions [missing]
32
+		Operators:
33
+			==
34
+			=~
35
+			and/&
36
+			or/|
37
+			not/!
38
+		Lvalues:
39
+			- uri
40
+			- method
41
+			- src_ip
42
+			- dst_ip
43
+			- myself
44
+		Rvalues:
45
+			- string
46
+			- integer
47
+			- ipv4 or ipv6 address
48
+			- netv4 or netv6 address
49
+			- myself (matches any uri or ip address the server listens on or 
50
+			 registered as an alias for the server)
51
+			
52
+	Commands:
53
+		- forward
54
+		- send
55
+		- error [not implemented yet ]
56
+		- log
57
+		- exec
58
+		- route/goto
59
+		- drop/break
60
+		- if {} else{}
61
+	Modules:
62
+		- loadmodule "..."
63
+		- commands registered by modules
64
+
65
+
... ...
@@ -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 64
     
65 65
     <toc></toc>
66 66
     
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">
67
+    <chapter id="general">
68
+	<title>General Information</title>
69
+	<para>
70
+	<section id="about_ser">
71
+	    <title>About SIP Express Router (ser)</title>
72
+	    <para>
73
+ SIP Express Router (SER) is an industrial-strength, free VoIP 
74
+server based on the session initiation protocol (SIP RFC2543-bis). 
75
+It is engineered to power IP telephony infrastructures up to large 
76
+scale. The server keeps track of users, sets up VoIP sessions, 
77
+relays instant messages and creates space for new plug-in applications. 
78
+Its proven interoperability guarantees seamless integration with 
79
+components from other vendors, eliminating the risk of a single-vendor 
80
+trap. It has successfully participated in various interoperability 
81
+tests in which it worked with the products of other leading SIP vendors.
82
+	    </para>
83
+	    <para>
84
+The SIP Express Router enables a flexible plug-in model for new 
85
+applications: Third parties can easily link their plug-ins with 
86
+the server code and provide thereby advanced and customized services. 
87
+In this way, plug-ins such as SNMP support, RADIUS accounting,
88
+or SMS gateway have already been developed and are provided as 
89
+advanced features. Other modules are underway: Presence server,
90
+firewall control, and more.
91
+
92
+	    </para>
93
+	    <para>
94
+Its performance and robustness allows it to serve millions of users and accommodate needs of very large operators. With a $3000 dual-CPU, the 
95
+SIP Express Router is able to power IP telephony services in an area 
96
+as large as the Bay Area during peak hours. Even on an IPAQ PDA, the server 
97
+withstands 150 calls per second (CPS)! The server has been powering our 
98
+iptel.org free SIP site withstanding heavy daily load that is further 
99
+increasing with the popularity of Microsoft's Messenger.  
100
+	
101
+	    </para>
102
+	    <para>
103
+The SIP Express Router is extremely configurable to allow the creation of 
104
+various routing and admission policies as well as setting up new and 
105
+customized services. Its configurability allows it to serve many roles: 
106
+network security barrier, application server, or PSTN gateway guard for 
107
+example.
108
+		</para>
109
+
110
+	    
111
+	</section> 
112
+
113
+	<section id="about_iptel">
68 114
 	    <title>About iptel.org</title>
69 115
 	    <para>
70 116
 		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 130
 		    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 131
 		</para>
132 132
 		<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.
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.
134 134
 		</para>
135 135
 		<para>
136 136
 		    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