OS4X Core installation

From OS4X

Automatic installer (.sh)

Download the appropriate "automatic installer" package for your platform, supported database and ISDN connectivity. It will have a filename ending with ".sh", i.e.:

os4x3_full_pe_Linux-x86-MySQL.sh

Change the permissions of the downloaded file in order to make it executable:

chmod 755 os4x3_full_pe_Linux-x86-MySQL.sh

Then, start this automatic installer:

./os4x3_full_pe_Linux-x86-MySQL.sh

The installer will ask you several questions:

  • temporary directory (for extraction of files)
  • base installation directory, which is the basis for the following directories:
    • binary installation directory
    • scripts directory
    • database backup directory
    • data incoming directory
    • outgoing data directory
    • OS4X's own temporary directory
    • RRDB directory (for statistical data, about 300kB per partner)
  • web interface directory

In case of a MySQL database connection, the server parameters will be asked for, given the database name will be created and a user added to MySQL.

The global configuration file '/etc/os4x.conf' will be generated automatically.

TAR Package

Unpack the provided TAR archive file for your platform, database and ISDN connectivity. You get the following directory structure (limited to the most important):

|-- apache
|   |-- images
|   |-- os4x
|   `-- os4xapi
|-- etc
|-- opt
|   `-- os4x
|       |-- ComSecure
|       |-- backup
|       |-- bin
|       |-- bots
|       |-- cert
|       |-- incoming
|       |-- outgoing
|       |-- plugins
|       |-- rrd
|       |-- scripts
|       `-- tmp
|-- os4xapi
|-- sql
`-- webaccess5

Filesystem directories

The created directory structure under "/opt" shows a suggestion for a standard installation. All directories will get defined via web interface, so keep in mind that the names can change. An explanation for each directory is as follows:

backup

In this directory backup files of the MySQL database can be stored. The scripts os4xbackup, os4xrestore and os4x_archive.sh use this directory.

bin

The binaries of the installation are stored here. The directory must at least contain the following binaries:

  • os4xeq3 – program to enqueue files into the send queue
  • os4xped3 – program to edit partner entries in the database
  • os4xrd3 – the receiving daemon
  • os4xsqd3 – the send queue daemon

cert

Global certificates, needed for resolving certificate chain resolution, are stored in this directory.

incoming

Incoming files which get successfully transfered by os4xrd get placed here. This should be an own filesystem. It must also be on the same filesystem as the directory „tmp“ (see below). The user running the OS4X processes must have read, write and execute permissions on that directory. For easy administration, set permissions to 777 (a+rwx).

outgoing

For availability reasons, we suggest to use an own filesystem for outgoing files. The send queue daemon can send every file available on the system.

rrd

Statistical files (like RRDtool database files) are stored in this directory. Per partner about 320kB of data is needed.

scripts

Event scripts are stored in this directory by default. These scripts are called whenever a session is started or ended, files start to transfer or the end of transfer is reached.

tmp

Temporary files like files during the receiving process are stored in this directory. After successful transfer they are moved into the incoming directory. Keep in mind to set the size to the maximum file size you can receive because these files will be temporarily stored into this directory. This directory must be on the same filesystem as incoming, otherwise the moving process cannot be done. The user running the OS4X processes must have read, write and execute permissions on that directory. For easy administration, set permissions to 777 (a+rwx).

Notes about upgrades

If you upgrade from an older OS4X version, you will see that the names of the binaries have changed. Some new binaries are new, others (like „os4xeq“) have a new name („os4xeq3“). A symbolic link is created to support the complete web interface for the older and the newer OS4X version. The web interface calls all binaries without the appendix „3“, so without the links (i.e. „os4xeq“ -> „os4xeq3“, „os4xsqd“ -> „os4xsqd3“ and so on), the web interface will display errors.

MySQL

Either you use a graphical interface for managing the database settings (i.e. phpMyAdmin or MySQLCC), or you can use the commandline tools provided by your local MySQL installation.

The MySQL command line client should be called by a user who has administrative rights on the MySQL database (mostly "root"), otherwise use the command line parameters "-u" and "-p" to provide a valid MySQL user (with password, if needed) which has the administrative permissions.

Create MySQL database

Choose a name for your database where OS4X stores its information. In this installation example, we use the name "os4x" as the database name.

Commandline call:

mysqladmin [-uroot] [-p] create os4x 

Create MySQL user

Now, create a MySQL user who gets full permissions on this database. We use "os4x" for simplicity.

echo "GRANT ALL ON os4x.* TO os4x@localhost IDENTIFIED BY 'os4x';" | mysql [-uroot] [-p] 
echo "FLUSH PRIVILEGES;" | mysql [-uroot] [-p] 

(Color explanation: green → database name; blue → username; red → password)

The user must get all available MySQL permission in this database, because internal upgrade mechanism (as described in the "Advanced administration documentation") will try to extend or modify the database schema! OS4X supports MySQL databases from version 3.23 up to the latest MySQL version (which is 5.0 and 5.1beta when creating this document). Since MySQL version 4.x, the password hashing algorithm in the database server has changed. Because OS4X supports also older MySQL server versions, it uses an older client protocol than your MySQL server provides. In order to use your prefered MySQL server version anyway, you can modify the created MySQL user. If you experience any problems when starting OS4X processes and Syslog contains the message "Client does not support authentication protocol requested by server; consider upgrading MySQL client", you have two options:

echo "SET PASSWORD FOR 'os4x'@'localhost'= OLD_PASSWORD('os4x');" | mysql [-uroot] [-p] 

(if the above user information and password were used)

echo "FLUSH PRIVILEGES;" | mysql [-uroot] [-p]

Import MySQL tables

Use the provided file „os4x.sql“ as the data source for the mysql import process:

mysql [-uroot] [-p] os4x < os4x.sql 

Where the first "os4x" is the database name for your installation (see above).

Main configuration

Copy the main configuration file os4x.cfg from the distribution directory

dist/etc/os4x.conf

to

/etc/os4x.conf

Then, configure the appropriate variables in this file. A sample configuration file looks like this:

DB_HOST=localhost 
DB_USER=os4x 
DB_PASS=os4x 
DB_NAME=os4x 
# DB_SOCKET=/var/lib/mysql.sock 
# DB_PORT=3306 
TABLEPREFIX=os4x_ 
# SERVERID=0
MYSQLCLIENT=/usr/bin/mysql

Lines with a hash ("#") at the beginning of a line are interpreted as a comment. The variable

DB_PORT

is only used for remote MySQL databases. The tableprefix defines the prefix for all internally fix names of tables, not the partner table as defined in the basic configuration (the default of "os4x_" should not be changed if you haven't modified all table names manually!).

Web interface

The web interface communicates to the OS4Xapi, which expects the configuration file located in

/etc/os4x.conf

If you need a different location, please contact support@os4x.com.

License key

In order to run OS4X you need a valid license key. To obtain a key you can order a two week test license through the website of OS4X or buy a full license (also see the homepage or ask a reseller). In any case, you need to know your OS4X ID, which can be displayed with the tool os4xlic. A sample output of this program looks like this:

root@localhost:/opt/os4x/bin> ./os4xlic 
OS4X license tool v2.0

your OS4X ID is:
4149155fba54270581d695301504346ed19960172c112bf258ece6d681320b8av3cmrcl

(all in one line)

After having received a valid license file ("license.key") either via software vendor or emergency key, copy it in the binary installation directory. Just copy the file with keeping the original filename. The binary installation directory is where all OS4X programs are located (i.e. "/opt/os4x/bin/"). This directory depends on your configuration.



Congratulations, you are now ready to continue with your OS4X configuration by surfing with your favorite web browser to the OS4X's web interface (located in the configured position, see above).