For a complete introduction to Interchange config files and the supported syntax, please see the configuration glossary entry.
Table of Contents
-
AcceptRedirect
— accept Web server redirects
-
Accounting
—
-
AccumulateCode
— fetch Interchange code on-demand from CodeRepository instead of starting up with everything
-
AcrossLocks
— open real databases instead of fast dummy pointers
-
ActionMap
— modify existing or define custom Interchange actions
-
AddDirective
— add a new configuration directive
-
AdminSub
— restrict specific global subroutines to catalogs listed under AllowGlobal directive
-
AdminUser
— (obsolete) specify usernames that are given full access to all catalogs, regardless of any permissions
-
AliasTable
— specify table containing page aliases ("redirect" instructions)
-
AllowGlobal
— specify catalogs allowed to operate with full Interchange server permissions
-
AllowRemoteSearch
— specify database tables accessible for remote searches
-
AlwaysSecure
— specify pages that are always to be served over a HTTPS connection
-
AsciiTrack
— specify filename to which formatted order reports should be appended
-
AutoEnd
— specify macro to be executed automatically at the end of every page access
-
AutoModifier
— specify products table columns containing values for product attributes
-
AutoVariable
— specify config directives to make available through the Variable space
-
Autoload
— specify actions to be executed automatically at the beginning of every page access
-
BounceReferrals
— remove visible affiliate code from URLs after first access
-
BounceReferralsRobot
— remove visible affiliate code from URLs after first access (for robots only)
-
BounceRobotSessionURL
— remove explicit mv_session_id in RobotUA request if provided
-
Capability
— test existence of a capability
-
CartTrigger
— specify subroutines to invoke when cart contents change
-
CartTriggerQuantity
— specify whether quantity changes to cart items will cause CartTrigger subroutines to execute
-
Catalog
— register catalog with the Interchange server
-
CatalogUser
— specify catalog-specific usernames to use when accessing files with absolute pathnames
-
CategoryField
— specify name of the "category" field in the Interchange database
-
CheckHTML
— check the generated HTML code with an external program
-
ChildLife
— define maximum child process lifetime
-
CodeDef
— generic subroutine mapper
-
CodeRepository
— specify directory containing code that can be included in the running installation when needed
-
CommonAdjust
— define default settings for a flexible, chained item pricing scheme
-
ConfDir
— specify catalog "config" directory
-
ConfigAllAfter
— specify config files to read as part of every catalog's configuration, after all its files are read in first
-
ConfigAllBefore
— specify config files to read as part of every catalog's configuration, before any of its files are read in
-
ConfigDatabase
— specify database holding definitions usually found in catalog.cfg
-
ConfigDir
— specify default "include" directory for "<file" notation
-
ConfigParseComments
— (obsolete) treat config meta-directives as plain comments
-
CookieDomain
— set domain common to all servers providing Interchange content
-
CookieLogin
— allow autologin based on username and password stored in a client cookie
-
CookieName
— specify Interchange session cookie name
-
CookiePattern
— specify regular expression to extract session ID out of a client cookie
-
Cookies
— specify whether Interchange will try to send session cookies to client browsers
-
CountrySubdomains
— honor ccTLD domains in IP qualification
-
CreditCardAuto
— encrypt credit card information automatically
-
CustomShipping
— specify SQL query to use in obtaining shipping costs data
-
DNSBL
— specify real-time DNS blocklist servers
-
DataTrace
— trace DBI calls with variable granularity
-
Database
— register existing database table for use with Interchange
-
DatabaseAuto
— register database tables for use with Interchange automatically
-
DatabaseAutoIgnore
— prevent DatabaseAuto from configuring tables whose names match regex pattern
-
DatabaseDefault
— specify default settings for Database directives
-
DebugFile
— specify Interchange debug output filename
-
DebugHost
— restrict debug mode to requests originating from specific hosts
-
DebugTemplate
— specify format of debug messages
-
DefaultLocale
— specify default locale
-
DefaultShipping
— specify default shipping method
-
DeleteDirective
— disable use of specified configuration directive in catalog.cfg
-
DeliverImage
— allow delivery of images through Interchange
-
DescriptionField
— specify name of the "description" field in the Interchange database
-
DirConfig
— batch-set a bunch of variables (or values in general) from files
-
DirectiveDatabase
— specify database to read configuration directives from
-
DirectoryIndex
— specify the default page in a directory
-
DiscountSpaceVar
— specify names of CGI variables to check for discount space definition
-
DiscountSpacesOn
— enable "discount spaces" feature
-
DisplayErrors
— display eventual errors directly in the client session
-
DomainTail
— honor only the toplevel domain in IP qualification
-
DowncaseVarname
—
-
DumpAllCfg
— dump global Interchange server configuration
-
DumpStructure
— dump Interchange server and catalog structure for each catalog
-
EnableJSONPost
—
-
EncryptKey
— specify default key to use for encryption
-
EncryptProgram
— specify default encryption program
-
Environment
— specify environment variables to inherit from the calling CGI link program
-
ErrorDestination
— route error messages to different files, based on message content or arbitrary tag
-
ErrorFile
— specify error log filename
-
ExecutionLocale
— specify lowest-level locale
-
External
— enable dump of selected global and catalog values for use by external programs
-
ExternalExport
— specify Perl variables to dump to external file
-
ExternalFile
— specify external dump filename
-
ExtraSecure
— disallow unencrypted access to pages which are listed under AlwaysSecure
-
FallbackIP
—
-
Feature
— specify Interchange "feature" for activation in the catalog
-
FeatureDir
— specify "feature" directory
-
FileControl
— specify page names and Perl subroutines that implement access control
-
FileDatabase
— specify table and column to look up in search for file contents
-
Filter
— specify variables and filters through which they should be run through automatically
-
FormAction
— define or override form action
-
FormIgnore
— specify variables that should not be propagated from CGI to Values space
-
FractionalItems
— allow fractional quantities in the shopping cart
-
FullUrl
— use full URLs (those including hostnames) in catalog definition lines
-
FullUrlIgnorePort
—
-
Glimpse
— specify program path and options for the Glimpse search engine
-
GlobalSub
— define global Perl functions for use within Interchange
-
HTMLsuffix
— specify filename extension for files in the PageDir and TemplateDir directories
-
HammerLock
— number of seconds after which a locked session is considered lost due to malfunction
-
History
— how many most-recent user clicks should be saved in session history
-
HitCount
— increment a counter on every catalog access
-
HostnameLookups
— perform hostname lookups (DNS resolving)
-
HotDBI
— specify catalogs that should use persistent database connections
-
HouseKeeping
— specify number of seconds between periodic "house keeping" jobs
-
HouseKeepingCron
— define Interchange-aware crontab entries
-
IPCsocket
— specify IPC socket filename
-
ImageAlias
— specify alias location for all image files
-
ImageDir
— specify base location for all image files
-
ImageDirInternal
— (obsolete)
-
ImageDirSecure
— specify base location for all IMG and INPUT src= files served over HTTPS
-
Inet_Mode
— specify whether Interchange server should open an INET socket and listen on a port
-
InternalCookie
—
-
IpHead
— use only part of the IP to qualify user sessions
-
IpQuad
— specify number of dot-quads to honor when IpHead is enabled
-
ItemAction
— specify subroutine to invoke when users' electronic cart contents change
-
Jobs
— define parameters for batch jobs
-
Levies
— specify levy sections to apply
-
Levy
— define levy section (levy key)
-
Limit
— set or modify various limits
-
Locale
— specify locale definitions
-
LocaleDatabase
— specify database that contains locale settings
-
LockType
— specify file locking method to use
-
LockoutCommand
— specify command to run in order to lock a client out of the site
-
LogFile
— specify Interchange log output filename
-
Logging
— specify log granularity treshold
-
MailOrderTo
— specify e-mail address that completed orders should be sent to
-
Mall
— issue cookies only for the current catalog, and not the base domain
-
MasterHost
— specify regular expression that client IP must match to access protected directories
-
MaxQuantityField
— specify tables and columns containing maximum allowed quantity for an item
-
MaxRequestsPerChild
— define maximum number of per-server page deliveries before respawn
-
MaxServers
— define maximum number of spawned servers
-
Member
— override catalog variables for logged-in users
-
Message
— write custom message to console and Interchange log
-
MimeType
— specify MIME types
-
MinQuantityField
— specify table and/or column containing minimum allowed quantity for an item
-
MoreDB
— enable saving of search paging files into users' DBI sessions
-
NoAbsolute
— deny catalogs to read absolute filenames on the system
-
NoExport
— specify databases not to re-export
-
NoExportExternal
— enable use of the NoExport directive
-
NoImport
— specify databases not to re-import, unless the database completely disappears
-
NoImportExternal
— do not re-import external databases
-
NoSearch
— specify databases on which Interchange-style searches cannot be performed
-
NonTaxableField
— specify name of the non-taxable field in the products database
-
NotRobotUA
— specify user-agents that will NOT be classified as crawler bots (search engines)
-
OfflineDir
— specify directory to use for "offline" files
-
OnFly
— enable on-fly additions to client shopping cart
-
Options
—
-
OptionsAttribute
—
-
OptionsEnable
— specify table and/or column for option type
-
OrderCleanup
—
-
OrderCounter
— specify file that keeps and increments order count
-
OrderLineLimit
— specify maximum number of items the user is allowed to place in the shopping cart
-
OrderProfile
— specify files containing order profile definitions
-
OrderReport
— specify location of the order report form
-
OutputCookieHook
—
-
PGP
— encrypt complete order reports automatically
-
PIDcheck
— check running Interchange processes during the HouseKeeping routine
-
PIDfile
— PID filename
-
PageDir
— specify directory containing catalog pages
-
PageSelectField
— specify products database column used to select the flypage
-
PageTableMap
— map field names for page lookup tables
-
PageTables
—
-
ParseVariables
— parse (interpolate) config file variables
-
Password
— specify password for RemoteUser
-
PerlAlwaysGlobal
—
-
PerlNoStrict
—
-
PermanentDir
— specify directory containing temporary files for permanent searches
-
PostURL
— specify URL for POST requests
-
Pragma
— specify pragma's default value
-
PreFork
— specify whether Interchange server should pre-fork processes that wait for client connections
-
PreForkSingleFork
— perform one instead of two forks in PreFork mode
-
Preload
— specify macro to be executed at the very beginning of every request
-
PriceCommas
— show thousands separator in price pictures
-
PriceDefault
— specify default price field in chained pricing schemes
-
PriceDivide
— specify number to divide the price by, to obtain price in units
-
PriceField
— specify name of the "price" field in the Interchange database
-
ProcessPage
— specify "virtual" location of the form processor page
-
ProductDir
— specify directory containing database files
-
ProductFiles
— specify all databases containing products that form one big "products" database
-
Profile
—
-
Profiles
— specify files containing OrderProfile definitions on a global level
-
Promiscuous
— allow output of HTML code in value variables
-
QueryCache
—
-
ReadPermission
— affect file mode (read permissions, specifically) on Interchange-generated files
-
RedirectCache
— use Interchange to generate static web server pages
-
RemoteUser
— specify required value of the REMOTE_USER environment variable
-
Replace
— reset directive to a new value, or to its default
-
Require
— require existence of a capability
-
RobotHost
— specify hostnames that will be classified as crawler bots (search engines) visiting the site
-
RobotIP
— specify IP numbers or ranges that will be classified as crawler bots (search engines)
-
RobotLimit
— specify maximum number of pages a user can visit without a short pause
-
RobotUA
— specify user-agents that will be classified as crawler bots (search engines)
-
Route
— specify order and payment routes
-
RouteDatabase
—
-
RunDir
— specify directory containing runtime files
-
SOAP
— enable handling of SOAP RPC requests
-
SOAP_Action
— define SOAP actions
-
SOAP_Control
— control access to SOAP features
-
SOAP_Enable
—
-
SOAP_MaxRequests
— define maximum number of per-server SOAP RPC response deliveries before respawn
-
SOAP_Perms
— specify SOAP RPC Unix socket permissions
-
SOAP_Socket
— specify name of SOAP RPC socket file
-
SOAP_StartServers
— specify number of servers which should be started to handle SOAP RPC requests
-
SafeTrap
— specify operation codes to trap in Safe.pm compartments
-
SafeUntrap
— specify operation codes to untrap in Safe.pm compartments
-
SalesTax
— specifies sales tax calculation mode
-
SalesTaxFunction
— specify custom tax calculation function
-
SaveExpire
— specify the amount of time for which Interchange cookies should be valid (their expiry time)
-
ScratchDefault
— define default scratch variable values
-
ScratchDir
— specify directory containing temporary files
-
SearchProfile
— specify files containing search profile definitions
-
SecurePostURL
— specify URL for secure POST requests
-
SecureURL
— specify base URL of the Interchange catalog link program, when pages are served over HTTPS
-
SendMailProgram
— sendmail (or compatible) binary location
-
SeparateItems
— treat items with quantity greater than 1 as separate items
-
SessionCookieSecure
—
-
SessionDB
— specify name of a database to use with DBI-based sessions
-
SessionDatabase
— specify location of the file-based user sessions database
-
SessionExpire
— specify a duration after which idle user sessions expire
-
SessionHashLength
— specify the number of characters to hash session directories
-
SessionHashLevels
— specify the number of levels to hash session directories
-
SessionLockFile
— specify the name of a lock file if DBM-based sessions are used
-
SessionType
— specify type of the user sessions database
-
SetGroup
— specify primary Unix group to switch to, after catalog to invoke is determined
-
Shipping
—
-
ShowTimes
— insert timing information in debug output
-
SocketFile
— specify Unix socket filename
-
SocketPerms
— specify Unix socket permissions
-
SocketReadTimeout
— specify timeout on client sockets
-
SourceCookie
—
-
SourcePriority
— specify list of CGI variables to check for source (affiliate) name
-
SpecialPage
— specify location of special pages
-
SpecialPageDir
— specify directory containing special catalog pages
-
SpecialSub
— specify Perl subroutines to handle certain events or conditions
-
StartServers
— specify the number of Interchange servers to prefork when running in PreFork mode
-
StaticDir
— (obsolete) specify path of the directory which should be used as root for static pages
-
Sub
— define Perl functions for use within a catalog
-
SubCatalog
— register subcatalog with the Interchange server
-
Suggest
— check existence of a capability
-
SuppressCachedCookies
—
-
SysLog
— instruct Interchange to log to Unix system's log (syslog)
-
TableRestrict
— restrict database searches to rows satisfying given criteria
-
TagDir
— specify directories containing code declaration blocks
-
TagGroup
— group Interchange code declarations in groups, for later convenient inclusion or exclusion from the setup
-
TagInclude
— include (a group of) tags in Interchange
-
TaxInclusive
— display prices with tax amount included
-
TaxShipping
—
-
TcpHost
— specify which hosts can connect to Interchange server running in Inet mode
-
TcpMap
— specify which ports should Interchange server running in Inet mode listen on
-
TemplateDir
— specify common template/fallback "pages" directories
-
TolerateGet
— specify whether information from both GET and POST method should be parsed when form is submitted using POST method
-
TrackDateFormat
— specify time format used in TrackFile logs
-
TrackFile
— specify user tracking log filename
-
TrackPageParam
— insert specified variables' values in the user track file
-
TrustProxy
— designate certain IP addresses or hostnames as trusted HTTP proxies
-
UTF8
—
-
Unix_Mode
— specify whether Interchange server should open an UNIX socket
-
UnpackJSON
—
-
UpsZoneFile
— specify file containing region-specific UPS zone information
-
UrlSepChar
— specify default URL separator character
-
UseModifier
— specify default attributes that can be attached to items
-
UserControl
— enable enhanced user database functions
-
UserDB
— adjust default behavior of Interchange user database functions
-
UserDatabase
— specify name of table to use as user database
-
UserTag
— define an Interchange tag
-
UserTrack
— enable sending of X-Track HTTP header
-
ValuesDefault
— define default user values
-
VarName
— remap Interchange variables to arbitrary names in generated URLs
-
Variable
— define an Interchange variable
-
VariableDatabase
— specify database containing variables
-
VendURL
— specify base URL of the Interchange catalog link program
-
WideOpen
— disable IP-based qualification of user sessions (the directive degrades catalog security!)
-
Windows
— (obsolete) indicate that Interchange is running under Microsoft Windows
-
WritePermission
— affect file mode (write permissions) on Interchange-generated files
-
XHTML
— enable XHTML-conformant HTML output