MAIN configuration file

the file config.tcl is the main configuration file of the BID server. More...

Variables
string	SEND = yes
	send email out at the end of plugin processing
string	DEBUG = no
	use the debug mode to write additional data into the log-file
string	SYSMAIL = $USER@$HOST
	the default From mime header token used in system eMails
string	SYSADMIN = UNKNOWN
	user responsible for BID server administration
string	SYSGROUP = UNKNOWN
	the default group to send out warn and alarm eMails
string	SYSGROUPNAME = "My Super Support Team"
	the name of the group responsible for send out emails
string	sendType = localhost
	the smtp server used to send out emails
string	APPMAILRELAY = UNKNOWN
	the smtp eMail address of the BID server able to forward eMails to the APPMAILHOST
string	APPMAILHOST = UNKNOWN
	the smtp server able to forward eMails to the Internet
string	SPAM_INTERVALL = 900
	minimum time in seconds between two eMails send out to the same receiver
string	SPAM_ID = default
	use SPAM_ID to identify the receiver
string	DEV_HOST = UNKNOWN
	the smtp eMail address of the BID server used for plugin development

---

Detailed Description

the file config.tcl is the main configuration file of the BID server.

Attention:

The doxygen documentation builder was primary developted for the C, C++, JAVA, ... language documentation and does not support the Tcl syntax.
The following translation rules have to be applied:

variable	string NAME = DEFAULT	set NAME DEFAULT
variable	array NAME = DEFAULT	array set NAME DEFAULT
procedure	string NAME ( type ARG1, ... )	proc NAME {ARG1 ...}
procedure	string NAME ( optional ARG1=DEF1, ... )	proc NAME {{ARG1 DEF1} ...}

---

Variable Documentation

string SEND = yes

send email out at the end of plugin processing

SEND is used to finally send out emails processed by BID. if set to yes processed email will be send out and if set to no not.

string DEBUG = no

use the debug mode to write additional data into the log-file

DEBUG is used to set "1/yes" or not set "0/no" the debug mode during debugging additional information is written into the log-file

string SYSMAIL = $USER@$HOST

the default From mime header token used in system eMails

string SYSADMIN = UNKNOWN

user responsible for BID server administration

Attention:

"," allowed to support multiple addresses

this user get all administration eMails belonging to the BID server and is responsible to fix problems and to release new plugins.

string SYSGROUP = UNKNOWN

the default group to send out warn and alarm eMails

Attention:

"," allowed to support multiple addresses

the SYSGROUP has more users than the SYSADMIN and gets monitoring information but not the BID server administration information

string SYSGROUPNAME = "My Super Support Team"

the name of the group responsible for send out emails

The html plugin is using this name to add the "mail-to" description

string sendType = localhost

the smtp server used to send out emails

localhost means the local email server and everything other than localhost means the DNS/IP name of a smtp server ready for receiving emails

string APPMAILRELAY = UNKNOWN

the smtp eMail address of the BID server able to forward eMails to the APPMAILHOST

The BID server on APPMAILRELAY has the permission to forward eMails to the APPMAILHOST.
To use the APPMAIL feature the user have to add the appmail: prefix to the To mime header token.
example:

SetHeader To appmail:myemail@internet

string APPMAILHOST = UNKNOWN

the smtp server able to forward eMails to the Internet

string SPAM_INTERVALL = 900

minimum time in seconds between two eMails send out to the same receiver

This variable is used to avoid mass email sending and is defined as minimum time in seconds between two or more eMails to the same receiver from the same plugin. Same is defined by joining the ID (plugin-name) with the To mime header token. All same emails will be attached to the first blocked eMail and send out after maximum SPAM_INTERVALL seconds. No eMail will be deleted but multiple eMails will be joined together.

string SPAM_ID = default

use SPAM_ID to identify the receiver

In difference to SPAM_INTERVALL use the string SPAM_ID to define the eMails belonging together. With SPAM_ID it is possible to control the eMails for multiple plugins in one SPAM.

string DEV_HOST = UNKNOWN

the smtp eMail address of the BID server used for plugin development

If a plugin can not be found in the local BID server the plugin:

plugins/self/default.tcl

is called and the eMail is forwarded to the BID server on the plugin reference host. If this BID server is not able to find the plugin an error is created and the SYSADMIN will be informed.

Attention:

on the development host the plugin self/default.tcl has the requirement: DEV_HOST = USER@HOST to work proper

---