boom Server readme

Please refer to the actual installation and user manual at
Worldline's boom support (Email: support@bes-worldline.com, Phone: +49 69 256 552 201).


	
Installation

All boom components are packaged in the boom*.zip server package. 
The first installation step therefore is always the server installation. 
The installation of all other components can only be performed after the server is installed and running.

Server Installation

After downloading the latest package, unzip the package to the folder in which the server should be installed 
(e.g. C:\Program Files\boom\boom_server or /usr/boom/boom_server).

The Installation expects to have a MySQL Database Server or Oracle installed
(for Oracle take a look at ORACLE_SQL/step1_create_boom_db.sql file for further
 installation requirements).

--- Unix ---

The installation needs to be performed by a user that has administrative rights (i.e. root) to be able to add files 
to the system startup directories. As first step you have to adapt entry JAVA_BIN="<java_17_repository_path>/bin" (Java 17) 
in configuration file boom_srv.cfg inside the installation folder - enter the following commands:

	cd /<boom_server_install_dir>/server
		vi boom_srv.cfg
			JAVA_BIN="<java_17_repository_path>/bin"

change the permissions of the install script to be able to execute it. 

	chmod 750 install

Run the installation script "install" by entering

	./install

The script will query the configuration settings, update the configuration files and perform all steps that are necessary to install the server. 
The script can handle most Linux distributions, HP-UX and SUN Solaris. For others some manual steps might be required 
e.g. to integrate the server with the system startup and shutdown routines.
If for some reasons the install script should not or can not be used, the following steps need to be performed manually to install the server:

    * Create the databases and initial table data by executing

      mysql -u root -p <c:\boom\step*.sql

      !!! Attention: existing tables will be deleted and re-created!
    
	* Edit the database configuration file db.props and update it with the MySQL instance and logon information
    
	* Edit the server management script boom_srv. Set the BOOM_SERVER variable to the installation directory, 
	  the JAVA and PATH information as described in the file.
    
	* Edit the server rc scripts ux_daemon.cfg/boom_srv exactly with the same information as above.
    
	* Copy the server rc script from ux_daemon.cfg/boom_srv to the init.d directory of the system. 
	  The exact location varies depending on the platform.
    
	* Create the symbolic links in the rc level directories as required. 
	  The location as well as the meaning of these vary for the different platforms.
    
	* Verify that all configurations are done correctly by starting the server with e.g.

      /etc/init.d/boom_srv start

      Check if any errors showed up or are logged in the server's log file in <install_dir>/BOOMServer_<date>.log

--- Mac OS X ---

	Mac OS X is not yet fully supported by the install script.
	To get registered in launchd make following steps:
	
	if the boom server installed not under /usr/boom/boom_server/ - change the appropriate line in
	the boom_server.plist file.
	
	cp boom_server.plist /Library/LaunchDaemons/
	launchctl load /Library/LaunchDaemons/boom_server.plist
	
	to start server: launchd start com.blixx.boom.server
	
	  
--- Windows ---

On the Windows platform some manual steps need to be performed to install the server:

    * Create the databases and the initial table data by executing

      "mysql -u root -p <C:\Program Files\boom\boom_server\step*.sql"

      Attention: Existing tables will be deleted and re-created!
    
	* Edit the database configuration file db.props and update it with the MySQL instance and logon information.
    
	* Open a command window by selecting Start->Run... and enter cmd, press OK.
      In the command window change to the installation directory by entering
      cd <install dir> (e.g. cd c:\Program Files\boom\boom_server)
      Register the boom Server as Windows Service with the command:
       -on systems with 32bit Java Runtime:
         booms_service_setup.exe -i
       -on systems with 64bit Java Runtime:
         booms_service_setup64.exe -i

      Note: On platforms with UAC like Windows Vista and Server 2008 the command must be executed with advanced privileges.
      Note: On 64bit Windows Systems with 64bit Java runtime the 32bit Service booms_service_setup.exe could be used, but
            the full path to the java.exe binary must than be specified in the boom_srv.cmd batch file.
    
	* Verify that all configurations are done correctly by starting the server with the Windows Service Control Panel. 
	Check if any errors showed up or are logged in the server's log file in <install_dir>/BOOMServer_<date>.log
        If no <install_dir>/BOOMServer_<date>.log is created check that java is installed and can be found by the
        system (i.e. see Note above regarding 32/64 bit Java and Service)

 