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