Configuration Reference

File Name and Location
File Syntax
Multiple Applications
Configuration Option Reference

File Name and Location

The configuration file is a text file named "steelblue.conf". It can be placed in the same directory as the SteelBlue executable. If it is not placed there, SteelBlue looks for it at C:/steelblue.conf for Win32 or at /etc/steelblue.conf for UNIX or LINUX.

File Syntax

Tags and Values

All configuration entries are of the form:

tag = value

where each tag/value pair is on a separate line. Tag names are case insensitive and are insensitive to the existence of "-" and "_". Therefore, "BasePageDir","base_page_dir" and "base-page-dir" are all equivalent. However, values are case sensitive. Please do not use quotes around the values.

Comments

Comments can be placed anywhere in the file. Comments begin with the character "#" and take up the rest of the line.

Whitespace

Blank lines and whitespace are ignored. Therefore, for Win32, it is important to use the DOS-compatible directory names if a directory contains a space.

Multiple Applications

Multiple application configurations are supported with BEGIN ... END blocks. The first line of the block must be "BEGIN appname" where "appname" is part of the Web path of the SteelBlue executable for that application (i.e. the REQUEST_URI environment variable for the CGI script). Therefore, multiple applications are created by placing the steelblue executable in different directory names (and using the directory name as "appname") or by copying or linking the SteelBlue executable under different names (and using the executable name as "appname").

A block is terminated by placing "END" in a line by itself.

If a SteelBlue application matches multiple BEGIN ... END blocks, later entries overwrite earlier entries.

Please see Installing SteelBlue for more information and an example steelblue.conf file.

Configuration Option Reference

Please note that tags in RED should be defined for minimal SteelBlue functionality.

Tag Name Purpose

AnonymousLogs If this variable is set to anything usernames will not be recorded in the log files.
Default: ""

AreaAccessTable Name of the AreaAccess table. If defined, the AreaAccess table is used to restrict access to pages based on group membership. Please see Security for more information.
Default: ""

BasePageDir Location for the SteelBlue scripts (application pages).
Default: "/home/httpd/BasePages/"

CheckUtil Web address of the CheckUtils.js script. This is required for client-side type checking of input elements.
Default: ""

CheckUtilFile Full file path of the CheckUtils.js script. This is required for client-side type checking of input elements for Netscape 3 browsers.
Default: ""

DBLoginErrorFile Name of the file to send to the user (typically in HTML) when the login to the database fails.
Default: ""

DBPassword Password for database access.
Default: ""

DBName Name of the database holding the SteelBlue and application tables.
Default: "STEELBLUE"

DBSystem System on which the database resides.
Default: "localhost"

DBUsername Username for database access.
Default: ""

DefaultInstitution Institution assigned to a guest users and the institution assigned to a password protected user if no institution is specified during log in.
Note: Errors may occur if set to the empty string ("") since it conflicts with NULL for some databases.
Default: "0"

DefaultLog Full file path to a general log file. If defined, messages sent by the LOG tag are recorded here.
Default: ""

ErrorsTo E-mail address to which SQL errors are sent. If defined, all SQL errors are e-mailed to this address.
Default: ""

EscapeType For ODBC, chooses the way single quotes are escaped.
Default: "double"
double - Duplicates single quotes (i.e. ' to '')
backslash - Backslashes single quotes (i.e. ' to \')

GroupsTable Name of the SteelBlue Groups table.
Default: "Groups"

HitLog Full file path to a hit log file. If defined, all accesses to the SteelBlue pages are recorded here.
Default: ""

IPChecking If not empty or zero, IP addresses of users are stored in the Ticket table. Therefore, users will not be able to change IP addresses during a session.
Default: "1"

LoginObject The security model. Please see Security for more information.
Default: "Login"
Login - All users are required to log-in and must match an entry in the AuthUsers table
PublicLogin - Users are assigned a guest username when they first access the SteelBlue executable

LoginScreen File path (relative to the BasePages directory) of the login HTML page used for the Login security model. It is displayed when a user tries to access the SteelBlue executable without logging in or when a user types an incorrect username and password when the LoginObject is set to "Login". Please see Security for more information.
Default: "login"

MailProg Full path to the sendmail executable. This is required for the EMAIL tag.
Default: ""

MaxUserDelete Maximum number of timed-out guest users to delete per session. This distributes the responsibility of deleting old sessions among multiple hits.
Default: "10"

OracleHome ORACLE_HOME environment variable. This is required for use with the ORACLE database.
Default: ""

RightPaddedDB Denotes that strings are padded with spaces in the ODBC database. Set to non-empty if varchar string types are not available.
Default: ""

SBExecutable Full path to the command-line steelblue executable. Used in the execSteelBlue() function.
Default: ""

SBURL Web path to the SteelBlue executable for this particular application.
Default: "/cgi-bin/steelblue"

ScreenAccessTable Name of the ScreenAccess table. If defined, the ScreenAccess table is used to restrict the possible SteelBlue pages accessible from a given SteelBlue page. Please see Security for more information.
Default: ""

SessionTimeout Maximum length of a single session in hours (can be fractional). After the specified number of hours, the user's ticket will expire.
Default: "4"

SQLErrorLog Full file path to a SQL error log file. If defined, all SQL errors are stored in this log file.
Default: ""

SwapLength Sets the length to which Swap data is truncated (required for some databases to avoid SQL errors).
Default: "200"

SwapTable Name of the SteelBlue Swap table.
Default: "Swap"

TicketTable Name of the SteelBlue Ticket table.
Default: "Ticket"

TimeOut For UNIX or LINUX, sets the maximum number of seconds a SteelBlue process can run before being automatically terminated. If set to "", the SteelBlue process will not be automatically terminated.
Default: ""

Timezone Number of hours (positive or negative) of the current timezone from UTC (i.e. EST is "-5"). It is required for proper conversion of the current local time in dtTime().
Default: ""

UseDB Type of database used. This must be filled with a database type for which the SteetBlue executable was compiled.
Default: ""
ODBC - ODBC database (Win32 only)
MSQL - mSQL database
MYSQL - mySQL database
ORACLE - ORACLE database PGSQL - Postgres database SYBASE - Sybase database

UserTable Name of the SteelBlue AuthUsers table.
Default: "AuthUsers"

WelcomeScreen File path (relative to the BasePages directory) of the first SteelBlue script executed after successful login (either public or by username/password).
Default: "welcome"

Tag Name	Purpose
AnonymousLogs	If this variable is set to anything usernames will not be recorded in the log files. Default: ""
AreaAccessTable	Name of the AreaAccess table. If defined, the AreaAccess table is used to restrict access to pages based on group membership. Please see Security for more information. Default: ""
BasePageDir	Location for the SteelBlue scripts (application pages). Default: "/home/httpd/BasePages/"
CheckUtil	Web address of the CheckUtils.js script. This is required for client-side type checking of input elements. Default: ""
CheckUtilFile	Full file path of the CheckUtils.js script. This is required for client-side type checking of input elements for Netscape 3 browsers. Default: ""
DBLoginErrorFile	Name of the file to send to the user (typically in HTML) when the login to the database fails. Default: ""
DBPassword	Password for database access. Default: ""
DBName	Name of the database holding the SteelBlue and application tables. Default: "STEELBLUE"
DBSystem	System on which the database resides. Default: "localhost"
DBUsername	Username for database access. Default: ""
DefaultInstitution	Institution assigned to a guest users and the institution assigned to a password protected user if no institution is specified during log in. Note: Errors may occur if set to the empty string ("") since it conflicts with NULL for some databases. Default: "0"
DefaultLog	Full file path to a general log file. If defined, messages sent by the LOG tag are recorded here. Default: ""
ErrorsTo	E-mail address to which SQL errors are sent. If defined, all SQL errors are e-mailed to this address. Default: ""
EscapeType	For ODBC, chooses the way single quotes are escaped. Default: "double" double - Duplicates single quotes (i.e. ' to '') backslash - Backslashes single quotes (i.e. ' to \')
GroupsTable	Name of the SteelBlue Groups table. Default: "Groups"
HitLog	Full file path to a hit log file. If defined, all accesses to the SteelBlue pages are recorded here. Default: ""
IPChecking	If not empty or zero, IP addresses of users are stored in the Ticket table. Therefore, users will not be able to change IP addresses during a session. Default: "1"
LoginObject	The security model. Please see Security for more information. Default: "Login" Login - All users are required to log-in and must match an entry in the AuthUsers table PublicLogin - Users are assigned a guest username when they first access the SteelBlue executable
LoginScreen	File path (relative to the BasePages directory) of the login HTML page used for the Login security model. It is displayed when a user tries to access the SteelBlue executable without logging in or when a user types an incorrect username and password when the LoginObject is set to "Login". Please see Security for more information. Default: "login"
MailProg	Full path to the sendmail executable. This is required for the EMAIL tag. Default: ""
MaxUserDelete	Maximum number of timed-out guest users to delete per session. This distributes the responsibility of deleting old sessions among multiple hits. Default: "10"
OracleHome	ORACLE_HOME environment variable. This is required for use with the ORACLE database. Default: ""
RightPaddedDB	Denotes that strings are padded with spaces in the ODBC database. Set to non-empty if varchar string types are not available. Default: ""
SBExecutable	Full path to the command-line steelblue executable. Used in the execSteelBlue() function. Default: ""
SBURL	Web path to the SteelBlue executable for this particular application. Default: "/cgi-bin/steelblue"
ScreenAccessTable	Name of the ScreenAccess table. If defined, the ScreenAccess table is used to restrict the possible SteelBlue pages accessible from a given SteelBlue page. Please see Security for more information. Default: ""
SessionTimeout	Maximum length of a single session in hours (can be fractional). After the specified number of hours, the user's ticket will expire. Default: "4"
SQLErrorLog	Full file path to a SQL error log file. If defined, all SQL errors are stored in this log file. Default: ""
SwapLength	Sets the length to which Swap data is truncated (required for some databases to avoid SQL errors). Default: "200"
SwapTable	Name of the SteelBlue Swap table. Default: "Swap"
TicketTable	Name of the SteelBlue Ticket table. Default: "Ticket"
TimeOut	For UNIX or LINUX, sets the maximum number of seconds a SteelBlue process can run before being automatically terminated. If set to "", the SteelBlue process will not be automatically terminated. Default: ""
Timezone	Number of hours (positive or negative) of the current timezone from UTC (i.e. EST is "-5"). It is required for proper conversion of the current local time in dtTime(). Default: ""
UseDB	Type of database used. This must be filled with a database type for which the SteetBlue executable was compiled. Default: "" ODBC - ODBC database (Win32 only) MSQL - mSQL database MYSQL - mySQL database ORACLE - ORACLE database PGSQL - Postgres database SYBASE - Sybase database
UserTable	Name of the SteelBlue AuthUsers table. Default: "AuthUsers"
WelcomeScreen	File path (relative to the BasePages directory) of the first SteelBlue script executed after successful login (either public or by username/password). Default: "welcome"