INSTALL
550bb8c3
 $Id$
 
46b14bad
 ******************************************************
 * Note well: ser has not been released yet. Tarballs *
 * available at berlios are meant for developers.     *
 * Stay tuned -- we will release ser shortly,         *
 * including RPM packages and documentation.          *
 *                                                    *
 * -Jiri, 2002-09-23                                  *
 ******************************************************
 
 
cb7dae9d
 
 TODO
 --we'll probably go for mysql dependancy,
   then INSTALL needs to be completely
   changed
 
 
550bb8c3
 Installation Notes
 
8fac7c9d
 Supported arhitectures: Linux/i386, Linux/armv4l, FreeBSD/i386, Solaris/sparc64,
0bafb279
 Win*/i386 (CYGWIN) - only the core
8fac7c9d
 (for other arhitectures the Makefile must be edited)
550bb8c3
 
628e3a5a
 There are various configuration options defined in the Makefile.
 
550bb8c3
 Requirements:
 
 
11ece359
 - gcc >= 2.9x; 3.0.x recommended (it will work with older version but it might
  require some options tweaking for best performance)
550bb8c3
 - bison or yacc (Berkley yacc)
 - flex
 - gmake (on Linux this is the standard "make")
 
b2dec9c6
 OS Notes:
550bb8c3
 
 - FreeBSD: make sure gmake, bison & flex are installed
 - Solaris: as above; you can use Solaris's yacc instead of bison
96001c50
 - Windows: it works in windows but you must install a recent cygwin version
 	(http://www.cygwin.com/) and also install a newer regex library version
 	(>=0.12). 
 	
550bb8c3
 
247c2b65
 
 
 Howto:
 (NOTE: if make doesn't work try gmake  instead)
 
 - compile with default options:
 
 make   #builds only ser core, equivalent to make ser
 make modules
 
 or make all #builds everything
 
 - compile with profiling
 
 make PROFILE=-pg all
 
 -compile debug mode version
 
 make mode=debug all
 
 -compile debug version with profiling
 
 make mode=debug PROFILE=-pg all
 
 -compile only the print module
 
 make modules=modules/print modules
 
 -compile all the modules except textops
 
 make exclude_modules="CVS textops" modules
 
b2dec9c6
 -compile with the "tm" module statically linked and with profiling
 
 make static_modules=tm PROFILE=-pg all
 
 -compile with gcc-3.0 instead of gcc
 
 make CC=gcc-3.0 all
 
247c2b65
 
 
 Make targets:
 
628e3a5a
 Clean:
247c2b65
 
628e3a5a
 make clean   (clean the modules too)
 make proper  (clean also the dependencies)
247c2b65
 make distclean (the same as proper)
 make mantainer-clean (clean everything, including auto generated files,
  tags, *.dbg a.s.o)
628e3a5a
 
550bb8c3
 Compile:
 
628e3a5a
 make proper
550bb8c3
 make
 (or gmake on non-Linux systems)
390bec9b
 make modules 
 or make modules exclude_modules="CVS print" etc.
550bb8c3
 
247c2b65
 Make tags:
 
 make TAGS
 
 Create a tar.gz with the sources:
 
 make tar
 
0294499f
 Create a tar.gz with the binary distribution:
247c2b65
 
0294499f
 make bin
247c2b65
 
bc5cc4ec
 Create a solaris package:
 
 make sunpkg
 
 Install:
550bb8c3
 
 make prefix=/usr/local  install
 
cb7dae9d
 
 
 Quick-Start Installation Guide
 ----------------------------------------------
 
 This guide give you instructions on how to
 set up the SIP Express Router (ser) on your
 box quickly. In case the default configuration
 does not fly, check documentation at ser site
   http://www.iptel.org/ser
 If the documentation does not resolve your 
 problem you may try contacting us by E-mail at
   serhelp@iptel.org
  
 Note well the default configuration is very simple
 in order to be easily installable and provides
 minimum features. Particularly, authentication
 is disabled, which means anyone can register using
 any name with the server. (This is on purpose to
 avoid installation dependencies on MySQL which is
 needed for storing user credentials.)
 
 
 A) Quick Start
 ----------------------------------------------
 
 1) Download an RPM package from our site
 	http://www.iptel.org/ser/
 2) install the package
 	rpm -i <pachage_name>
 3) start the server
 	/etc/init.d/ser start
 4) optionally, watch server's health using the
    serctl utility
 	- to do so, first set the environment
 	  variable SIP_DOMAIN to your domain 
 	  name, e.g., in Bourne shell, call
 	    export SIP_DOMAIN="foo.bar"
 	- run the serctl utility
 	    /usr/sbin/serctl moni
 5) Register with the server using your favorite
    SIP User Agent. You may want to look at configuration
    hints for use of iptel.org site at
      http://www.iptel.org/phpBB/viewforum.php?forum=1&8
    For example, users of Windows Messenger need to set
    in Tools->Options->Accounts the foolowing values:
      Sign-in Name: <username>@<your_server_address>
      Advanced->Configure Settings (on)
      Advanced->Server: <your_server_address>
      Connect Using: UDP
 
 
 
 B) ser with Persistent Data Storage
 ----------------------------------------------
 The default configuration is very simple and
 features many simplifications. In particular,
 it does not authenticate users and loses 
 User Location database on reboot. To provide
 persistency, keep user credentials and remember
 users' locations across reboots, ser can be
 configured to use MySQL. Before you proceed,
 you need to make sure MySQL is installed on
 your box.
 
 
 1) Download an RPM *source* package from our site
 	http://www.iptel.org/ser/
 2) install the package
 	rpm -i <pachage_name>
 3) compile the package
 4) install the package
 5) create MySQL tables
     /usr/sbin/ser_mysql.sh create
 6) configure ser to use SQL
     uncomment all lines which are related to 
     authentication:
     - loadmodule "/usr/lib/ser/modules/mysql.so"
     - loadmodule "/usr/lib/ser/modules/auth.so"
     - modparam("usrloc", "db_mode", 2)
     - modparam("auth", "secret", "alsdkhglaksdhfkloiwr")
     - modparam("auth", "calculate_ha1", yes)
     - if (!www_authorize("iptel.org", "subscriber")) {
         www_challenge("iptel.org", "0"); 
         break;
       };
 7) restart the server
 	/etc/init.d/ser start
 
 
 
 C) Troubleshooting
 ----------------------------------------------
 
d8159ce1
 /etc/ser/ser.cfg
 /etc/init.d/ser restart
 listen
 aliases
cb7dae9d