OS4X Core environment variables

From OS4X
Revision as of 19:44, 1 May 2007 by Admin (talk | contribs)
Jump to navigation Jump to search

Some environment variables are created and/or set by all OS4X binaries. These variables are:

  • OS4X_CFGFILE: OS4X main configuration file (absolute path information)
  • OS4X_IN_DIR: incoming data directory
  • OS4X_OUT_DIR: outgoing data directory
  • OS4X_TMP_DIR: temporary data directory
  • OS4X_BIN_DIR: binary program directory
  • OS4X_SCRIPT_DIR: script installation directory
  • OS4X_BACKUP_DIR: backup directory
  • RAND_FILE: entropy file for OFTP2 needs
  • OPENSSL_BIN: absolute path to openSSL binary
  • RRDTOOL_BIN: absolute path to RRDtools binary
  • RRDB_DATAPATH: RRD data path

All processes started by OS4X (event scripts, plugins, etc.) have access to these environment variables. The environment variable "OS4X_CFGFILE" points to the absolute path to the OS4X main configuration file. This has two effects:

  • you may start OS4X programs in a shell where this variable is set without using the parameter "-C" for all binaries (because the environment variable points to the correct position of the configfile)
  • all subsequent processes started by OS4X (like event scripts) don't have to bother about the given configfile (like plugins of OS4X Enterprise).