Browse code

INSTALL update for release

Olle E. Johansson authored on 11/03/2013 10:36:54
Showing 1 changed files
... ...
@@ -7,16 +7,15 @@
7 7
 
8 8
      ==================================================
9 9
 
10
-  Welcome! This is an amazingly flexible, robust
11
-  and secure SIP server built on years of experience in several Open
12
-  Source projects. It's a merge of the SIP Express Router (SER) and the
13
-  Kamailio (OpenSER) products produced by a joint development team. When
14
-  not explicitely mentioned, SIP server refers to any of these two
15
-  applications.
16
-
17
-  This memo gives you hints how to set up the SIP server quickly.
10
+  Welcome! This is an amazingly flexible, robust and secure SIP server
11
+  built on years of experience in several Open Source projects. It's a merge
12
+  of the SIP Express Router (SER) and the Kamailio (OpenSER) products produced
13
+  by a joint development team. When not explicitely mentioned, SIP server refers
14
+  to any of these two applications.
15
+
16
+  This memo gives you hints on how to set up the SIP server quickly.
18 17
   
19
-  You can find similar tutorial and many more on project's web site:
18
+  You can find a similar tutorial and many more on project's web site:
20 19
     - http://www.kamailio.org/w/documentation/
21 20
     - http://www.kamailio.org/wiki/
22 21
   
... ...
@@ -272,7 +271,7 @@ is 'cfg'.
272 271
 
273 272
 B) Build Commands
274 273
 
275
-  SIP server is split in four main parts: The core, the modules, the
274
+  The SIP server is split in four main parts: The core, the modules, the
276 275
   utilties, and scripts/examples.  When you build, you can decide to build
277 276
   only the core, the modules, both, or all.
278 277
 
... ...
@@ -297,8 +296,8 @@ Including groups of modules:
297 296
   modules to include, according to their status:
298 297
   - standard - Modules in this group are considered a standard part of SIP server
299 298
     (due to widespread usage) but they have no dependencies (note that some of
300
-	these interplay with external systems.
301
-    However, they don't have compile or link dependencies).
299
+    these interplay with external systems. However, they don't have compile
300
+    or link dependencies).
302 301
 
303 302
   - db - Modules in this group use databases and need a database driver to run.
304 303
     Included are drivers for the text mode db (dbtext) and for dumping
... ...
@@ -306,14 +305,13 @@ Including groups of modules:
306 305
     postgres groups.
307 306
 
308 307
   - standard_dep -  Modules in this group are considered a standard part of SIP
309
-    server(due to widespread usage)
310
-    but they have dependencies that most be satisfied for compilation.
308
+    server (due to widespread usage) but they have dependencies that must be satisfied
309
+    for compilation.
311 310
     NOTE! All presence modules (dialog, pa, presence_b2b, rls, xcap) have been
312 311
 	included in this group due to interdependencies
313 312
 
314 313
   - stable - Modules in this group satisfy specific or niche applications,
315
-    but are considered stable for production use. They may or may not have
316
-	dependencies
314
+    and are considered stable for production use. They may or may not have dependencies
317 315
 
318 316
   - experimental - Modules in this group are either not complete, untested, or
319 317
     without enough reports of usage to allow the module into the stable group.
... ...
@@ -418,6 +416,7 @@ Configure:
418 416
 
419 417
   Example: 
420 418
 	make cfg include_modules=mysql mode=debug
419
+
421 420
   All future make invocations will include the mysql module and will build in debug mode
422 421
 
423 422
   Note: if config.mak doesn't exist (e.g. initial checkout or after a make 
... ...
@@ -574,14 +573,13 @@ C) Quick Start
574 573
   authentication, then you have to install additional database support --
575 574
   proceed to section D) after you are finished with C).
576 575
 
577
-  1) Download an RPM or debian package from site
576
+  1) Download an RPM or Debian package from the links on the wiki
578 577
 
579
-    ****** site not available yet
578
+    http://www.kamailio.org/wiki/
580 579
 
581 580
   If you don't use an rpm or debian based distribution, try our tar.gz'ed
582 581
   binaries
583
-
584
-  ******* not available yet
582
+    http://www.kamailio.org/pub/kamailio/latest/src/
585 583
 
586 584
   If you use Solaris 8 you can try our solaris package.
587 585
   If you use Gentoo Linux you do not have to download a package.
... ...
@@ -647,9 +645,7 @@ C) Quick Start
647 645
 
648 646
   5) Connect SIP phones
649 647
 
650
-  Register with the server using your favorite SIP User Agent. You may want to look 
651
-  at configuration hints for use of various clients on iptel.org site at
652
-     http://www.iptel.org/phpBB/viewforum.php?forum=1&8
648
+  Register with the server using your favorite SIP User Agent (phone). 
653 649
 
654 650
   In most cases, you need to set the following options:
655 651
 
... ...
@@ -665,7 +661,8 @@ D) SIP Server with Persistent Data Storage
665 661
   The default configuration is very simple and features many simplifications. 
666 662
   In particular, it does not authenticate users and loses User Location database 
667 663
   on reboot. To provide persistence, keep user credentials and remember users' 
668
-  locations across reboots, SIP server can be configured to use a database, like MySQL. 
664
+  locations across reboots, Kamailio can be configured to use a database, like MySQL. 
665
+
669 666
   Before you proceed, you need to make sure MySQL is installed on your box. Your
670 667
   MySQL server must be configured to deal with a large number of
671 668
   connection. To increase it, set the following line in [mysqld] section
... ...
@@ -673,9 +670,9 @@ D) SIP Server with Persistent Data Storage
673 670
 
674 671
    set-variable    = max_connections=500
675 672
 
676
-  1) Download the package containing mysql support for SIP server from: 
677
-    
678
-    **** site not available yet
673
+  1) Download the package containing mysql support for SIP server from the links
674
+     you find on: 
675
+        http://www.kamailio.org/wiki/
679 676
 
680 677
     (rpm and deb provided, most of the binary tar.gz distributions and the 
681 678
      solaris package include it; if it is not present you'll have to rebuild