| |
The eloqsd.cfg configuration file defines eloqsd configuration.
The section names are not case sensitive. String values can be
enclosed in double quotes to protect leading or trailing spaces.
An unquoted hash character (#) starts a comment.
The following configuration items are recognized:
- Service
-
Specifies the service name (as defined in /etc/services)
or the port number where the server should listen for
requests. The default value is eloqsd.
- ServiceHttp
-
Specifies the service name (as defined in /etc/services)
or the port number where the server should listen for
HTTP requests. If ServiceHttp is not specified,
the HTTP status is disabled.
- Panic
-
This configuration item specifies what happens if eloqsd is
aborted due to a fatal problem.
The following options are valid:
- exit - Terminate the process. This is the default.
- dump - Terminate the process and create a core dump.
panic = dump is a problem tracking option. Unless you
know what you need the coredump for you probably want to stay
with the default.
- HttpUser
-
If set, the eloqsd HTTP status display will require a
matching user name (HTTP basic authentication) before
allowing access to the eloqsd HTTP status. The default value
is empty.
- HttpPswd
-
If set, the eloqsd HTTP status display will require a
matching password (HTTP basic authentication) before allowing
access to the eloqsd HTTP status. The default value is empty.
- HttpFrame
-
Numeric flag if the links should be omitted in the HTTP status.
The default value is 0.
- Lang
-
This configuration option defines the locale, the
server should use. The default value is "C".
The only locale currently supported is "C".
- Messages
-
This configuration option defines the language
for server messages. This value defaults to Lang.
The only locale currently supported is "C".
- Charset
-
This defines the character set encoding, the server
should use internally. Valid settings are:
-
HPROMAN8 - HP Roman8
-
ISO8859/1 - ISO 8859/1
The default value for HP-UX is HPROMAN8, all other
platforms default to ISO8859/1.
This setting is used by the server to translate
client strings like user or file names.
- AuthPolicy
-
The AuthPolicy config item specifies, how user names
and passwords are validated by default. The following options
are valid:
- server
- On HP-UX and Linux the server will validate passwords and
user names using the userFile
(eloqsd.user).
On Windows the server will validate user names using the
userFile and pass the
resulting uid
(Windows account) and the password to the operating system.
After a successful login, the process continues to run with the
user's permissions.
- user (Windows)
- An operating system user account must be used to run the
server which must be different from the SYSTEM account.
All processes are run with this account's permissions. The
userFile is used to validate
both user names and passwords.
- pam (HP-UX and Linux)
- Users are authenticated through PAM
(Pluggable Authentication Modules), the
userFile configuration
is not used.
The default value is "server".
- LogonType (Windows)
-
If AuthPolicy is set to "server",
the LogonType item specifies how to logon a user to the
operating system. The following options are valid:
- interactive
- The "interactive" logon type is used. This mode grants
access to all resources the same user would have when logging on
interactively.
Note that on Windows domain controllers, this requires the
"allow log on locally" user right to be granted in the Windows
Domain Controller Security Policy.
- batch
- The "batch" logon type is used which is meant for
background processes. This was used originally in older eloqsd
versions but turned out to be restricted in recent Windows server
versions. It requires the "log on as a batch job" user right to
be granted.
The default value is "interactive".
- userFile
-
The path/name of the eloqsd.user file.
The default is eloqsd.user in the Eloquence configuration directory.
- appFile
-
The path/name of the eloqsd.app file.
The default is eloqsd.app in the Eloquence configuration directory.
- shareFile
-
The path/name of the eloqsd.share file.
The default is eloqsd.share in the Eloquence configuration directory.
- pswdFile
-
The path/name of the eloqsd.pswd file.
The eloqsd.pswd file holds encrypted eloqsd passwords.
The default is eloqsd.pswd in the Eloquence configuration directory.
- DefaultUID
-
The name (or numeric id) of the system account to run client processes
as, unless a different setting is provided for the user.
On Windows if this account is located on a domain server, it must be
prefixed with the domain name followed by a backslash
character (DOMAIN\username).
DefaultUID = eloqsd
#DefaultUID = Guest
- DefaultGID (HP-UX, Linux)
-
The name (or numeric id) of the system group to run client processes
as, unless a different setting is provided for the user.
DefaultGID = eloqsd
- LogFile
-
This defines where log messages are written to.
This configuration value either specifies a path/file
or one of the keywords below:
- console - log messages are written to the console
- syslog - log messages will be sent to the
syslog daemon (HP-UX, Linux) or the Windows Event Log.
The default value is "syslog".
- SysIdent (HP-UX, Linux)
SysFacility (HP-UX, Linux)
-
This may be used to specify the syslog identifier and facility.
Supported facility values are: USER/DAEMON/LOCAL0..LOCAL7.
The default syslog identifier is "eloqsd".
The default syslog facility is "USER".
Please refer to syslogd(1M) for more information.
For example:
SysIdent = eloqsd
SysFacility = USER
- LogFlags
-
Each log message has an associated origin and
severity. The log flags define, which messages will
be logged. The "*" origin matches all message origins,
so it can be used to setup a default which can be
overridden for a specific message origin (eg. "*1N0").
Default LogFlags are "*0"
The following origins are in use:
-
* = All origins
-
C = Configuration subsystem
-
N = Network transport
-
P = Protocol handling
The following severities are in use:
-
ERROR = 0 - error messages
-
INFO = 1 - information
-
DEBUG = 2 - debug
-
VDEBUG = 3 - verbose debug
When using syslog, the following priorities
are mapped:
-
ERROR = LOG_ERR
-
INFO = LOG_NOTICE
-
DEBUG = LOG_DEBUG
-
VDEBUG = LOG_DEBUG
Enabling log messages with DEBUG or VDEBUG severity
may result in a huge number of log messages.
To suppress anything but fatal messages, you can set
LogFlags to "*0". To enable informational log messages
LogFlags should be set to "*1".
- MaxUsers (HP-UX, Linux)
MaxTasks (HP-UX, Linux)
-
The MaxUsers configuration item specifies the maximum
number of TASKIDs. This also limits the number of concurrent eloqcore processes. The default value is 40.
The MaxTasks configuration item specifies the maximum
number of TASKIDs to reserve for "secondary" eloqcore processes.
The default value is 20.
MaxUsers = 40
MaxTasks = 20
eloqsd.cfg template file
A default configuration file eloqsd.cfg is installed and may be customized.
A template eloqsd config file is installed as
newconfig/config/eloqsd.cfg.
# eloqsd.cfg
# @(#) $Revision: 1.1 $
#
# The purpose of this file is to define the eloqsd properties.
# It is installed in the location:
# /etc/opt/eloquence/8.2/eloqsd.cfg
# C:/Program Files/Eloquence/8.2/etc/eloqsd.cfg
#
# This file is read once at eloqsd startup.
#
# Format:
#
# The section names are not case sensitive. String values can be
# enclosed in double quotes to protect leading or trailing spaces.
# Everything after a hash (#) character is considered a comment.
# Default values are provided commented out.
### Server configuration
[Config]
# Service The service name (as defined in /etc/services)
# or the port number where the server should listen
# for requests. The default value is eloqsd.
#
# ServiceHttp The service name (as defined in /etc/services)
# or the port number where the server should listen
# for HTTP requests. If this is not specified, the
# HTTP status is disabled.
#
#Service = eloqsd
#ServiceHttp =
# panic This option defines what should happen if a fatal
# error is encountered.
#
# The following options are valid:
# exit Terminate the process. This is the default.
# dump Terminate the process and create a core dump.
#
# This is a problem tracking option. Unless you know what
# you need the coredump for you probably want to stay with
# the default
#panic = exit
# HttpFrame Numeric flag if the links should be omitted in
# HTTP status. The default value is 0.
# HttpFrame = 0
# HttpUser =
# HttpPswd =
# Lang This configuration option defines the locale, the
# server should use. The default value is "C".
# The only locale currently supported is "C".
#
# Messages This configuration option defines the language
# for server messages. This value defaults to Lang.
# The only locale currently supported is "C".
#
# Charset This defines the character set encoding, the server
# should use internally.
#
# Valid settings are:
# HPROMAN8 - HP Roman8
# ISO8859/1 - ISO 8859/1
# The default value for HP-UX is HPROMAN8, all other
# platforms default to ISO8859/1.
#
# This setting is used by the server to translate
# client strings like user or file names.
#Lang = C
#Messages = C
#Charset = HPROMAN8
# AuthPolicy This entry specifies, how user names and passwords
# are validated. The following entries are valid:
#
# server - The server will validate passwords and user
# names using eloqsd.user (HP-UX and Linux)
#
# On Windows the server will validate user names
# using the eloqsd.user and pass the resulting
# UID and the password to the operating system.
# After a successful logon, the process continues
# to run with the user's permissions.
#
# user - An operating system user account must be
# used to run the server which must be different
# from the SYSTEM account. All processes are
# run with this account's permissions. The
# userFile is used to validate both user names
# and passwords. (Windows)
#
# pam - Users are authenticated through PAM
# (Pluggable Authentication Modules),
# the eloqsd.user configuration is not used
# (HP-UX and Linux)
#
# The default value is "server".
#
# LogonType If AuthPolicy is set to "server", this entry specifies
# how to logon a user to the operating system (Windows).
# The following entries are valid:
#
# interactive - The "interactive" logon type is used. This
# mode grants access to all resources the same
# user would have when logging on interactively.
# Note that on Windows domain controllers, this
# requires the "allow log on locally" user right
# to be granted in the Windows Domain Controller
# Security Policy.
#
# batch - The "batch" logon type is used which is meant
# for background processes. This was used in
# previous eloqsd versions but turned out to be
# restricted in recent Windows server versions.
# It requires the "log on as a batch job" user
# right to be granted.
#
# The default value is "interactive".
#
# userFile The path/name of the eloqsd.user file.
# The default value depends on your operating system:
# HP-UX and Linux: /etc/opt/eloquence/8.2/eloqsd.user
# Windows: C:/Program Files/Eloquence/8.2/etc/eloqsd.user
#
# appFile The path/name of the eloqsd.app file.
# The default value depends on your operating system:
# HP-UX and Linux: /etc/opt/eloquence/8.2/eloqsd.app
# Windows: C:/Program Files/Eloquence/8.2/etc/eloqsd.app
#
# shareFile The path/name of the eloqsd.share file.
# The default value depends on your operating system:
# HP-UX and Linux: /etc/opt/eloquence/8.2/eloqsd.share
# Windows: C:/Program Files/Eloquence/8.2/etc/eloqsd.share
#
# pswdFile The path/name of the eloqsd.pswd file.
# The default value depends on your operating system:
# HP-UX and Linux: /etc/opt/eloquence/8.2/eloqsd.pswd
# Windows: C:/Program Files/Eloquence/8.2/etc/eloqsd.pswd
#AuthPolicy = server
#HP-UX, Linux:
#userFile = /etc/opt/eloquence/8.2/eloqsd.user
#appFile = /etc/opt/eloquence/8.2/eloqsd.app
#shareFile = /etc/opt/eloquence/8.2/eloqsd.share
#pswdFile = /etc/opt/eloquence/8.2/eloqsd.pswd
#Windows:
#LogonType = interactive
#userFile = C:/Program Files/Eloquence/8.2/etc/eloqsd.user
#appFile = C:/Program Files/Eloquence/8.2/etc/eloqsd.app
#shareFile = C:/Program Files/Eloquence/8.2/etc/eloqsd.share
#pswdFile = C:/Program Files/Eloquence/8.2/etc/eloqsd.pswd
# DefaultUID The default name (or numeric id) of the system account
# to run client processes as, unless a different setting
# is provided for the user.
#
# On Windows if this account is located on a domain server,
# it must be prefixed with the domain name followed by a
# backslash character (DOMAIN\username).
#
# DefaultGID The default name (or numeric id) of the system group
# to run client processes as, unless a different setting
# is provided for the user. (HP-UX and Linux)
DefaultUID = eloqsd
#DefaultUID = Guest (Windows)
DefaultGID = eloqsd
# LogFile This defines where log messages are written to.
# This configuration value either specifies a path/file
# or one of the keywords below:
#
# console - log messages are written to the console
# syslog - log messages will be sent to the
# syslog daemon (HP-UX , Linux) or the
# Windows Event Log.
#
# The default value is "syslog".
#LogFile = syslog
# SysIdent When logging to the syslog daemon, you can define
# a syslog identifier. Default is eloqsd.
# See syslogd(1M) for more information
#
# SysFacility When logging to the syslog daemon, you can define
# a syslog facility (USER/DAEMON/LOCAL0..LOCAL7)
# The default setting is "USER".
# See syslogd(1M) for more information
#SysIdent = eloqsd
#SysFacility = USER
# LogFlags Each log message has an associated origin and
# severity. The log flags define, which messages will
# be logged. The "*" origin matches all message origins,
# so it can be used to setup a default which can be
# overridden for a specific message origin (eg. "*1N0"):
# Default LogFlags are "*0"
#
# The following origin are in use:
# * = All origins
# C = Configuration subsystem
# N = Network transport
# P = Protocol handling
#
# The following severities are in use:
# L_ERROR = 0 - error messages
# L_INFO = 1 - information
# L_DEBUG = 2 - debug
# L_VDEBUG = 3 - verbose debug
#
# When using syslog, the following priorities
# are mapped:
# L_ERROR = LOG_ERR
# L_INFO = LOG_NOTICE
# L_DEBUG = LOG_DEBUG
# L_VDEBUG = LOG_DEBUG
#
# Enabling log messages with L_DEBUG or L_VDEBUG severity
# may result in a huge number of log messages.
# To enable only fatal messages, you would want to set the
# LogFlags to "*0", to enable regular log messages you
# would want to set the LogFlags to "*1"
#LogFlags = *0
# Configuration items below are the more traditional eloqsd
# settings (HP-UX, Linux)
#
# MaxUsers Maximum number of eloqcore processes on the local
# system. The default value is 40.
#
# MaxTasks Maximum number of TASKIDs to reserve for "secondary"
# eloqcore processes. If you don't know what this is good
# for, you probably don't need it :-)
# The default value is 20
#MaxUsers = 40
#MaxTasks = 20
eloqsd
|
|
