OS4X Core main configuration file
- 1 Main configuration file
- 2 Examples
Main configuration file
OS4X's main configuration file defines be basic information about database connectivity and some other, really basic information which cannot reside in the database.
All OS4X binaries search the configuration file at
but they are all aware of searching this file at a given position. For this position information, nearly all binaries have the parameter "
-C" (beware of the uppercase!). Example:
$ /opt/os4x/bin/os4xrd -C /opt/os4x/os4x.conf
This example searches the config file at the given position "
In addition, all running OS4X binaries set the environment variable "OS4X_CFGFILE", which is also interpreted by all binaries. An alternative way to the above example could then be:
$ export OS4X_CFGFILE=/opt/os4x/os4x.conf $ /opt/os4x/bin/os4xrd
The configuration file contains textual information in the format "key=value", where no space must be existant between key, the character "=" and the corresponding value. Lines beginning with a hash sign ("#") are comments and will not be taken into account. Example:
# comment KEY=VALUE
Illegal defintions are:
KEY = VALUE <- whitespaces after key name and before value KEY =VALUE <- whitespace after key name KEY= VALUE <- whitespace before value
The following variables are available.
Resolvable hostname or IP address of the databse server. In case of MySQL, special rules apply: if the value "localhost" is used, the MySQL client library tries to connect via a compiled in socket connection, if no socket is configured. In this case, if you have any problems connecting to MySQL, examine your syslog output and check the socket availability. As a workaround, "127.0.0.1" can be configured for a forced TCP/IP connection to localhost.
Username for the database connection. In case of MySQL, if no username is configured (left empty), the user running the program is being used.
Password for the database connection. Empty connection passwords are not officially supported, but may work.
- MySQL: Name of the database.
- DB2: Name of the database instance.
Optional. Absolute path to the socket file for communication. Only valid for MySQL.
TCP/IP port number for communication with the database server.
Prefix of all OS4X tables. In shared database environment (where only one database is available) it's handy to have a configurable prefix for all tables. Default:
(beware of the underscore as a last character).
Absolute path to the MySQL client tool used for backup and restore reasons.
ID of the OS4X server in a cluster environment. Every OS4X server should have its own server ID, given by you.
Type of database connected to. Starting with OS4X 3 Core, possible values are:
If left empty, "
MYSQL" is assumed for compatibility reasons with OS4X 2 Core.
For a persistant database connection for every OS4X process, you may set this configuration value to the numerical value "1":
At the moment only effective with "
If you want OS4X Webaccess to connect to an alternative OS4X client daemon (possibly on a remote server), set here the resolvable hostname or IP address of the server. All OS4X client daemon communication (i.e. authentification, job generation) will take place on this server.
If you want a special upload directory used for this OS4X Webaccess instance, you can configure it here.
This feature is mainly used when installing OS4X Webaccess on a remote server (i.e. remote co-location). The same directory name must exist on the host running the OS4X client daemon for job generation. In most common cases, this is done by mounting the same directory with the exact name from the remote server on the host running the OS4X client daemon.
The following examples show various settings: locale and remote databases, socket connects, the possible database types and persistant connections.
local MySQL server via socket
DB_HOST=localhost DB_USER=os4x DB_PASS=os4x DB_NAME=os4x DB_SOCKET=/var/lib/mysql.sock DB_PORT=3306 TABLEPREFIX=os4x_ MYSQLCLIENT=/usr/local/mysql/bin/mysql
remote MySQL server and remote OS4X client daemon, using a different upload directory
DB_HOST=192.168.1.23 DB_USER=os4x DB_PASS=os4x DB_NAME=os4x DB_PORT=3306 TABLEPREFIX=os4x_ MYSQLCLIENT=/usr/local/mysql/bin/mysql CLIENTD_OVERRIDDEN_HOST=192.168.21.2 WEBACCESS_UPLOAD_DIRECTORY=/opt/os4x/upload_remote_location
DB_HOST=db2 DB_USER=db2inst1 DB_PASS=db2 DB_NAME=swan_hl DB_PORT=50000 TABLEPREFIX=os4x_ DBTYPE=DB2
remote DB2 with persistant connections and configured server ID
DB_HOST=db2 DB_USER=db2inst1 DB_PASS=db2 DB_NAME=swan_hl DB_PORT=50000 TABLEPREFIX=os4x_ DBTYPE=DB2 DB_PERSISTANT_CONNECTION=1 SERVERID=5