zopectlrc(5) · carta

NAME

zopectl.conf, zopectl.ini, zopectlrc - Zope instances configuration files

DESCRIPTION

The configuration file consists of sections, lead by a "[section]" header and followed by "name: value" entries, with continuations in the style of RFC 822; "name=value" is also accepted. Note that leading whitespace is removed from values. The optional values can contain format strings which refer to other values in the same section, or values in a special DEFAULT section. Format string are in the form '%(item)s', which means the this portion of value will be replaced with the value of 'item' key. Lines beginning with "#" or ";" are ignored and may be used to provide comments.

zopectl first reads zopectlrc file (configuring itself and loading system wide instances defaults values), then reads any instance's configuration file. zopectlrc file must be composed of two sections:

instances: The section in which are defined system wide defaults for any zope instance and optional useful variables.

zopectlrc: The section in which are defined values the modify the behaviour of zopectl command itself (actually none).

Each instance configuration file may define one or more instances, one per section. An optional DEFAULT section may be provided to override some system wide default options. Each section may at last override any previously set default option defining it anew. In any case, some of the option keys are required, and other are not.

OPTIONS

REQUIRED KEYS

basename: The configuration file basename without any file extension.

section: The name of the section that described the instance.

name: The name of the instance. A reasonable default is %(basename)s/%(section)s.

user: The user name that will be used to run the instance.

group: The group name that will be used to run the instance. A reasonable default is %(user)s

data-fs-in: The location of the default Data.fs file for new instances.

instance-home: Where instance files are located. A reasonable default is /var/lib/zope/instance/%(name)s.

zope-home: Where z2.py, zpasswd.py an the ZServer component are located.

software-home: Where other components and product are located.

OPTIONAL KEYS

access-file: This instance access file location.

access-username: This instance access initial/emergency username.

access-password: The initial/emergency user's password.

access-encoding: The format in which the initial/emergency user's password is encoded.

access-domains: The domains from which the initial/emergency user can log in (it is acceptable to leave this blank).

pcgi-error-log: The value of PCGI_ERROR_LOG in the pcgi resource file.

pcgi-exe: The value of PCGI_EXE in the pcgi resource file.

pcgi-module-path: The value of PCGI_MODULE_PATH in the pcgi resource file.

pcgi-name: The value of PCGI_NAME in the pcgi resource file. Must be "Zope".

pcgi-pid-file: The value of PCGI_PID_FILE in the pcgi resource file.

pcgi-publisher: The value of PCGI_PUBLISHER in the pcgi resource file.

pcgi-resource-file: The PCGI resource file location.

pcgi-socket-file: The value of PCGI_SOCKET_FILE in the pcgi resource file.

fastcgi-path-or-port: A UNIX socket file, or a port number that will be used by the FastCGI server.

z2-detailed-log-file: The instance detailed log file location.

event-log-file: The instance event log file.

event-log-format: The instance custom event logs format.

event-log-severity: The instance minimum accepted level for event logs.

zsyslog: The syslog device on which send event logs.

zsyslog-facility: The facility to use sending event logs to syslog.

zsyslog-server: The syslog UDP address:port to use to send event

zsyslog-access: Like zsyslog, but for access logs rather then event logs.

zsyslog-access-facility: Like zsyslog-facility, but for access logs rather then event logs.

zsyslog-access-server: Like zsyslog-server, but for access logs rather then event logs.

z2-log-file: The instance log file location.

z2-pid-file: The instance PID file location.

profile-publisher: A file name to which zope writes the profiling information of each request.

suppress-accessrule: If set, all SiteRoots are suppressed (used by SiteAccess products).

suppress-siteroot: If set, all site access rules are suppressed (used by SiteAccess products).

zsp-ownerous-skip: If set, will cause the Zope Security Policy to skip checks relating to ownership, for servers on which ownership is not important.

zsp-authenticated-skip: If set, will cause the Zope Security Policy to skip checks relating to authentication, for servers which serve only anonymous content.

zsession-add-notify: An optional full Zope path name of a callable object to be set as the "script to call on object addition" of the session_data transient object container created in temp_folder at startup.

zsession-del-notify: An optional full Zope path name of a callable object to be set as the "script to call on object deletion" of the session_data transient object container created in temp_folder at startup.

zsession-timeout-mins: The number of minutes to be used as the "data object timeout" of the "/temp_folder/session_data" transient object container.

zsession-object-limit: The number of items to use as a "maximum number of subobjects" value of the "/temp_folder" session data transient object container.

webdav-source-port-clients: Setting this variable enables the retrieval of the document source through the standard HTTP port instead of the WebDAV port. The value of this variable is a regular expression that is matched against the user-agent string of the client.

stx-default-level: Set this variable to change the default level for <Hx> elements.

zope-dtml-request-autoquote: Set this variable to one of "no", "0" or "disabled" to disable autoquoting of implicitly retrieved REQUEST data that contain a '<' when used in a dtml-var construction.

base-port: A value of [address:]port type that will be used to generate HTTP, FTP and monitor [address]:port values. Multiple values separated by white space are allowed.

http-port: A value of [address:]port type that will be used to listen for incoming HTTP connections. Multiple values separated by white space are allowed.

webdav-port: A value of [address:]port type that will be used to listen for incoming WebDAV connections. Multiple values separated by white space are allowed.

ftp-port: A value of [address:]port type that will be used to listen for incoming FTP connections. Multiple values separated by white space are allowed.

icp-port: A value of [address:]port type that will be used for load balancing between multiple back-end Zope servers and a ICP-aware front end. Multiple values separated by white space are allowed.

monitor-port: A value of [address:]port type that will be used for the secure monitor server port. Multiple values separated by white space are allowed.

use-management-process: A value that will be use to decide whether to start the management process or not.

check-interval: A value that will be used as interpreter check interval (in seconds).

dns: A value that will be used as the IP address of the DNS server.

listen: A value that will be used as the IP address to listen on for incoming connections.

locale: A value that will be used as the locale identifier for the instance message's localization.

number-of-tread: A value that will be used as the number of thread to use if ZODB3 is used.

zope-database-quota: An integer number of bytes.

zope-read-only: If this variable is set, then the database is opened in read only mode. If this variable is set to a string parsable by DateTime.DateTime, then the database is opened read-only as of the time given.

OTHER KEYS

Other neither REQUIRED, nor OPTIONAL keys may be provided as well. Those key will be ignored for the purpose of zopectl or instances configuration, but may provide useful values in format strings.

EXAMPLES

See /usr/share/doc/zopectl/examples/debugrc

AUTHOR

Luca - De Whiskey's - De Vitis <[email protected]>