Difference between revisions of "OS4X Core environment variables"

From OS4X
Jump to navigation Jump to search
Line 10: Line 10:
 
*<code>OPENSSL_BIN</code>: absolute path to openSSL binary  
 
*<code>OPENSSL_BIN</code>: absolute path to openSSL binary  
 
*<code>RRDTOOL_BIN</code>: absolute path to RRDtools binary  
 
*<code>RRDTOOL_BIN</code>: absolute path to RRDtools binary  
*<code>RRDB_DATAPATH</code>: RRD data path  
+
*<code>RRDB_DATAPATH</code>: RRD data path
 +
*<code>OS4X_WEBGUI_DIR</code>: web interface installation directory
 
All processes started by OS4X (event scripts, plugins, etc.) have access to these environment variables.  
 
All processes started by OS4X (event scripts, plugins, etc.) have access to these environment variables.  
 
The environment variable "<code>OS4X_CFGFILE</code>" points to the absolute path to the OS4X main configuration file. This has two effects:  
 
The environment variable "<code>OS4X_CFGFILE</code>" 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 "<code>-C</code>" for all binaries (because the environment variable points to the correct position of the configfile)  
 
*you may start OS4X programs in a shell where this variable is set without using the parameter "<code>-C</code>" 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).
 
*all subsequent processes started by OS4X (like event scripts) don't have to bother about the given configfile (like plugins of OS4X Enterprise).

Revision as of 19:50, 1 May 2007

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
  • OS4X_WEBGUI_DIR: web interface installation directory

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).