Browse code

quick-start added

Jiri Kuthan authored on 05/09/2002 20:15:43
Showing 1 changed files
... ...
@@ -1,5 +1,16 @@
1 1
 $Id$
2 2
 
3
+
4
+TODO
5
+--we'll probably go for mysql dependancy,
6
+  then INSTALL needs to be completely
7
+  changed
8
+--see TROUBLES -- on some hosts, like mine (Jiri)
9
+  ser binds to 127.0.0.1 -- not really good for
10
+  quick-start
11
+
12
+
13
+
3 14
 Installation Notes
4 15
 
5 16
 Supported arhitectures: Linux/i386, Linux/armv4l, FreeBSD/i386, Solaris/sparc64,
... ...
@@ -100,3 +111,138 @@ Install(not done yet):
100 111
 
101 112
 make prefix=/usr/local  install
102 113
 
114
+
115
+
116
+Quick-Start Installation Guide
117
+----------------------------------------------
118
+
119
+This guide give you instructions on how to
120
+set up the SIP Express Router (ser) on your
121
+box quickly. In case the default configuration
122
+does not fly, check documentation at ser site
123
+  http://www.iptel.org/ser
124
+If the documentation does not resolve your 
125
+problem you may try contacting us by E-mail at
126
+  serhelp@iptel.org
127
+ 
128
+Note well the default configuration is very simple
129
+in order to be easily installable and provides
130
+minimum features. Particularly, authentication
131
+is disabled, which means anyone can register using
132
+any name with the server. (This is on purpose to
133
+avoid installation dependencies on MySQL which is
134
+needed for storing user credentials.)
135
+
136
+
137
+A) Quick Start
138
+----------------------------------------------
139
+
140
+1) Download an RPM package from our site
141
+	http://www.iptel.org/ser/
142
+2) install the package
143
+	rpm -i <pachage_name>
144
+3) start the server
145
+	/etc/init.d/ser start
146
+4) optionally, watch server's health using the
147
+   serctl utility
148
+	- to do so, first set the environment
149
+	  variable SIP_DOMAIN to your domain 
150
+	  name, e.g., in Bourne shell, call
151
+	    export SIP_DOMAIN="foo.bar"
152
+	- run the serctl utility
153
+	    /usr/sbin/serctl moni
154
+5) Register with the server using your favorite
155
+   SIP User Agent. You may want to look at configuration
156
+   hints for use of iptel.org site at
157
+     http://www.iptel.org/phpBB/viewforum.php?forum=1&8
158
+   For example, users of Windows Messenger need to set
159
+   in Tools->Options->Accounts the foolowing values:
160
+     Sign-in Name: <username>@<your_server_address>
161
+     Advanced->Configure Settings (on)
162
+     Advanced->Server: <your_server_address>
163
+     Connect Using: UDP
164
+
165
+
166
+
167
+B) ser with Persistent Data Storage
168
+----------------------------------------------
169
+The default configuration is very simple and
170
+features many simplifications. In particular,
171
+it does not authenticate users and loses 
172
+User Location database on reboot. To provide
173
+persistency, keep user credentials and remember
174
+users' locations across reboots, ser can be
175
+configured to use MySQL. Before you proceed,
176
+you need to make sure MySQL is installed on
177
+your box.
178
+
179
+
180
+1) Download an RPM *source* package from our site
181
+	http://www.iptel.org/ser/
182
+2) install the package
183
+	rpm -i <pachage_name>
184
+3) compile the package
185
+4) install the package
186
+5) create MySQL tables
187
+    /usr/sbin/ser_mysql.sh create
188
+6) configure ser to use SQL
189
+    uncomment all lines which are related to 
190
+    authentication:
191
+    - loadmodule "/usr/lib/ser/modules/mysql.so"
192
+    - loadmodule "/usr/lib/ser/modules/auth.so"
193
+    - modparam("usrloc", "db_mode", 2)
194
+    - modparam("auth", "secret", "alsdkhglaksdhfkloiwr")
195
+    - modparam("auth", "calculate_ha1", yes)
196
+    - if (!www_authorize("iptel.org", "subscriber")) {
197
+        www_challenge("iptel.org", "0"); 
198
+        break;
199
+      };
200
+7) restart the server
201
+	/etc/init.d/ser start
202
+
203
+
204
+
205
+C) Troubleshooting
206
+----------------------------------------------
207
+
208
+
209
+
210
+TROUBLES
211
+
212
+In the following config, ser bound itself to /dev/lo -- not
213
+good for quick start.
214
+
215
+/etc/ser/ser.cfg
216
+/etc/init.d/ser restart
217
+listen
218
+aliases
219
+
220
+[root@cat log]# uname -a
221
+Linux cat 2.4.18-3 #1 Thu Apr 18 07:37:53 EDT 2002 i686 unknown
222
+
223
+/etc/hosts
224
+
225
+# Do not remove the following line, or various programs
226
+# that require network functionality will fail.
227
+127.0.0.1       cat     localhost.localdomain   localhost
228
+
229
+
230
+[root@cat log]# /sbin/ifconfig 
231
+eth0      Link encap:Ethernet  HWaddr 00:08:02:38:D9:A0  
232
+          inet addr:192.168.0.16  Bcast:192.168.0.255  Mask:255.255.255.0
233
+          UP BROADCAST RUNNING PROMISC MULTICAST  MTU:1500  Metric:1
234
+          RX packets:152917 errors:0 dropped:0 overruns:0 frame:0
235
+          TX packets:87759 errors:0 dropped:0 overruns:0 carrier:0
236
+          collisions:35 txqueuelen:100 
237
+          RX bytes:216441566 (206.4 Mb)  TX bytes:5542812 (5.2 Mb)
238
+          Interrupt:5 Base address:0x7000 
239
+
240
+lo        Link encap:Local Loopback  
241
+          inet addr:127.0.0.1  Mask:255.0.0.0
242
+          UP LOOPBACK RUNNING  MTU:16436  Metric:1
243
+          RX packets:162 errors:0 dropped:0 overruns:0 frame:0
244
+          TX packets:162 errors:0 dropped:0 overruns:0 carrier:0
245
+          collisions:0 txqueuelen:0 
246
+          RX bytes:10568 (10.3 Kb)  TX bytes:10568 (10.3 Kb)
247
+
248
+