Browse code

TOC added, "getting help" updated

Jiri Kuthan authored on 07/12/2002 11:53:10
Showing 1 changed files
... ...
@@ -2,6 +2,23 @@ $Id$
2 2
 
3 3
 
4 4
 Installation Notes
5
+===================
6
+
7
+TOC
8
+
9
+1. Supported Architectures and Requirements
10
+2. Howto Build ser From Source Distribution
11
+3. Quick-Start Installation Guide
12
+   A) Getting Help
13
+   B) Disclaimers
14
+   C) Quick Start
15
+   D) ser with Persistent Data Storage
16
+   E) Troubleshooting
17
+
18
+
19
+
20
+1. Supported Architectures and Requirements
21
+-------------------------------------------
5 22
 
6 23
 Supported arhitectures: Linux/i386, Linux/armv4l, FreeBSD/i386, OpenBSD/i386
7 24
 Solaris/sparc64 
... ...
@@ -36,9 +53,9 @@ OS Notes:
36 53
   install a newer regex library version (>=0.12). 
37 54
     
38 55
 
56
+2. Howto Build ser From Source Distribution
57
+-------------------------------------------
39 58
 
40
-
41
-Howto:
42 59
 (NOTE: if make doesn't work try gmake  instead)
43 60
 
44 61
 - compile with default options:
... ...
@@ -130,36 +147,40 @@ make prefix=/usr/local  install
130 147
 
131 148
 
132 149
 
133
-Quick-Start Installation Guide
150
+3. Quick-Start Installation Guide
134 151
 ----------------------------------------------
135 152
 
136
-This guide give you instructions on how to
137
-set up the SIP Express Router (ser) on your
138
-box quickly. In case the default configuration
153
+A) Getting Help
154
+
155
+This guide gives you instructions on how to set up the SIP Express 
156
+Router (ser) on your box quickly. In case the default configuration
139 157
 does not fly, check documentation at ser site
140
-  http://www.iptel.org/ser
141
-If the documentation does not resolve your 
142
-problem you may try contacting us by E-mail at
143
-  serhelp@iptel.org
158
+  http://www.iptel.org/ser/
159
+
160
+If the documentation does not resolve your problem you may try contacting 
161
+us by E-mail at serusers@iptel.org -- that is the mailing list of ser
162
+community from which you can get most rapid help. To participate in the
163
+mailing list, subscribe at the following web address:
164
+  http://mail.iptel.org/mailman/listinfo/serusers
165
+
166
+If you are concerned about your privacy, you may post your questions to 
167
+iptel.org's helpline at serhelp@iptel.org.
168
+
169
+B) Disclaimers
144 170
  
145
-Note well the default configuration is very simple
146
-in order to be easily installable and provides
147
-minimum features. Particularly, authentication
148
-is disabled, which means anyone can register using
149
-any name with the server. (This is on purpose to
150
-avoid installation dependencies on MySQL which is
151
-needed for storing user credentials.)
171
+Note well the default "quick-start" configuration is very simple in order 
172
+to be easily installable. It provides minimum features. Particularly, 
173
+authentication is by default disabled, which means anyone can register using
174
+any name with the server. (This is on purpose to avoid installation 
175
+dependencies on MySQL which is needed for storing user credentials.)
152 176
 
153 177
 
154
-A) Quick Start
178
+C) Quick Start
155 179
 
156
-The following step-by step guide gives you
157
-instructions how to install the sql-free
158
-distribution of ser. If you need persistancy
159
-and authentication, then you have to install
160
-additional MySql support -- proceed to section B)
161
-after you are finished with A).
180
+The following step-by step guide gives you instructions how to install the 
181
+sql-free distribution of ser. If you need persistancy and authentication, 
182
+then you have to install additional MySql support -- proceed to section D)
183
+after you are finished with C).
162 184
 
163 185
 1) Download an RPM or debian package from our site
164 186
     http://www.iptel.org/ser
... ...
@@ -197,7 +218,7 @@ Solaris:
197 218
    serctl utility
198 219
     - to do so, first set the environment variable SIP_DOMAIN to your domain 
199 220
       name, e.g., in Bourne shell, call
200
-        export SIP_DOMAIN="foo.bar"
221
+        export SIP_DOMAIN="myserver.foobar.com"
201 222
 	- if you are using other than 'localhost' mysql server for maintaining
202 223
 	  subscriber database, change the variable 'SQL_HOST' to the proper
203 224
 	  host name in the serctl script
... ...
@@ -219,20 +240,16 @@ Solaris:
219 240
 
220 241
 
221 242
 
222
-B) ser with Persistent Data Storage
243
+D) ser with Persistent Data Storage
223 244
 ----------------------------------------------
224
-The default configuration is very simple and
225
-features many simplifications. In particular,
226
-it does not authenticate users and loses 
227
-User Location database on reboot. To provide
228
-persistency, keep user credentials and remember
229
-users' locations across reboots, ser can be
230
-configured to use MySQL. Before you proceed,
231
-you need to make sure MySQL is installed on
232
-your box.
233
-
234
-
235
-1) Download the package containing the ser mysql module from: 
245
+The default configuration is very simple and features many simplifications. 
246
+In particular, it does not authenticate users and loses User Location 
247
+database on reboot. To provide persistency, keep user credentials and remember 
248
+users' locations across reboots, ser can be configured to use MySQL. Before you 
249
+proceed, you need to make sure MySQL is installed on your box.
250
+
251
+
252
+1) Download the package containing mysql support for ser from: 
236 253
     http://www.iptel.org/ser/
237 254
     (rpm and deb provided, most of the binary tar.gz distributions and the 
238 255
      solaris package include it; if it is not present you'll have to rebuild
... ...
@@ -244,7 +261,7 @@ your box.
244 261
 3) create MySQL tables
245 262
     /usr/sbin/ser_mysql.sh create
246 263
 4) configure ser to use SQL
247
-    uncomment all lines which are related to 
264
+    uncomment all lines in configuration file ser.cfg which are related to 
248 265
     authentication:
249 266
     - loadmodule "/usr/lib/ser/modules/mysql.so"
250 267
     - loadmodule "/usr/lib/ser/modules/auth.so"
... ...
@@ -253,33 +270,23 @@ your box.
253 270
     - if (!www_authorize("iptel.org", "subscriber")) {
254 271
         www_challenge("iptel.org", "0"); 
255 272
         break;
256
-      }; /* be sure to replace realm, the first parameter
257
-            in www_* actions, with name of your server;
258
-            some broken UAC implementations don't authenticate
259
-            otherwise
260
-          */
261
-5) restart the server
273
+      }; 
274
+5) be sure to replace realm, the first parameter in www_* actions, 
275
+   with name of your server; some broken UAC implementations don't 
276
+   authenticate otherwise; the authentication command in your
277
+   configuration script should look then like this:
278
+      if (!www_authorize("myserver.foobar.com", "subscriber")) {
279
+        www_challenge("myserver.foobar.com", "0"); 
280
+        break;
281
+      }
282
+6) restart the server
262 283
     /etc/init.d/ser restart
263
-6) you can now start  managing the server using
264
-   the serctl utility; you need to first set the
265
-   environment variable SIP_DOMAIN to your local
266
-   SIP realm, e.g.,
267
-       export SIP_DOMAIN="foo.bar"
268
-   The realm name should be the value you set in
269
-   step #4.
284
+7) you can now start  managing the server using the serctl utility; 
285
+   you need to first set the environment variable SIP_DOMAIN to your 
286
+   local SIP realm, e.g.,
287
+       export SIP_DOMAIN="myserver.foobar.com"
270 288
 
271 289
    a) watch the server status using 'serctl moni'
272
-   b) try to login as user 'admin' with password 'heslo'
290
+   b) try to login with your SIP client as user 'admin' with password 'heslo'
273 291
    c) try adding new users using 
274 292
        'serctl add <name> <password> <email>'
275
-
276
-
277
-
278
-C) Troubleshooting
279
-
280
-/etc/ser/ser.cfg
281
-/etc/init.d/ser restart
282
-listen
283
-aliases
284
-