Difference between revisions of "OS4X Core main configuration file"

From OS4X
Jump to navigation Jump to search
(New page: == 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 da...)
 
Line 6: Line 6:
 
  /etc/os4x.conf
 
  /etc/os4x.conf
 
but they are all aware of searching this file at a given position. For this position information, nearly all binaries have the parameter "<code>-C</code>" (beware of the uppercase!). Example:
 
but they are all aware of searching this file at a given position. For this position information, nearly all binaries have the parameter "<code>-C</code>" (beware of the uppercase!). Example:
  /opt/os4x/bin/os4xrd -C /opt/os4x/os4x.conf
+
  $ /opt/os4x/bin/os4xrd -C /opt/os4x/os4x.conf
 
This example searches the config file at the given position "<code>/opt/os4x/os4x.conf</code>".
 
This example searches the config file at the given position "<code>/opt/os4x/os4x.conf</code>".
 +
 +
In addition, all running OS4X binaries set the environment variable [[OS4X_Core_environment_variables|"OS4X_CFGFILE"]], which is also interpreted by all binaries. An alternative way to the above example could then be:
 +
$ xport OS4X_CFGFILE=/opt/os4x/os4x.conf
 +
$ /opt/os4x/bin/os4xrd
  
 
=== Content ===
 
=== Content ===
Line 14: Line 18:
 
  KEY=VALUE
 
  KEY=VALUE
  
 +
=== Variables ===
 
Illegal defintions are:
 
Illegal defintions are:
 
  KEY = VALUE
 
  KEY = VALUE

Revision as of 20:02, 10 May 2010

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.

Position

All OS4X binaries search the configuration file at

/etc/os4x.conf

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 "/opt/os4x/os4x.conf".

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:

$ xport OS4X_CFGFILE=/opt/os4x/os4x.conf
$ /opt/os4x/bin/os4xrd

Content

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

Variables

Illegal defintions are:

KEY = VALUE
KEY =VALUE
KEY= VALUE

Example

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