Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
265 lines (198 sloc) 8.65 KB


This is a temporary fork of plone.recipe.zope2instance that has slightly tweaked exit code handling. Unless you need this, we suggest using the upstream recipe.

This recipe creates and configures a Zope 2 instance in parts. It also installs a control script, which is like zopectl, in the bin/ directory. The name of the control script is the the name of the part in buildout.

You can use it with a part like this:

recipe = isotoma.recipe.zope2instance
zope2-location = /path/to/zope2/install
user = admin:admin
http-address = 8080
eggs = ${buildout:eggs} my.package
products = ${buildout:directory}/products
zcml = my.package


The path where Zope 2 is installed. If you are also using the plone.recipe.zope2install recipe, and you have that configured as a part called 'zope2' prior to the zope2instance part, you can use ${zope2:location} for this parameter.
A relative or absolute path to a zope.conf file. If this is not given, a zope.conf will be generated based on the the options below.
The path to the backup script. A wrapper for this will be generated in bin/repozo, which sets up the appropriate environment for running this. Defaults to "${zope2-location}/utilities/ZODBTools/". Set this to an empty value if you do not want this script to be generated.

The following options all affect the generated zope.conf:

A list of paths where Zope 2 products are installed. The first path takes precedence in case the same product is found in more than one directory.
If you want a custom site.zcml file, put its content here. If this option is used the zcml and zcml-additional options are ignored.
Install ZCML slugs for the packages listed, separated by whitespace. You can specify the type of slug by appending '-' and the type of slug you want to create. The valid types are configure, overrides and meta. Some examples: my.package-overrides my.package-meta
Extra ZCML statements that should be included in the generated site.zcml file.
A list of paths where additional python packages are installed. The paths are searched in the given order after all egg and products paths.
This controls what character set is used to encode unicode data that reaches ZPublisher without any other specified encoding. This defaults to 'utf-8'.
Set to 'on' to turn on debug mode in Zope. Defaults to 'off'.
Set to 'on' to turn on verbose security (and switch to the Python security implementation). Defaults to 'off' (and the C security implementation).
The name of the effective user for the Zope process. Defaults to not setting an effective user.
The default IP address on which Zope's various server protocol implementations will listen for requests. If this is unset, Zope will listen on all IP addresses supported by the machine. This directive can be overridden on a per-server basis in the servers section. Defaults to not setting an ip-address.
Offset applied to the port numbers used for ZServer configurations. For example, if the http-server port is 8080 and the port-base is 1000, the HTTP server will listen on port 9080. This makes it easy to change the complete set of ports used by a Zope server process. Zope defaults to 0.
Give a port for the HTTP server. Defaults to 8080.
Set to off to defer opening of the HTTP socket until the end of the Zope startup phase. Defaults to on. Note: This option requires Zope >= 2.11.
Give a port for the FTP server. This enables the FTP server.
Give a port for the WebDAV server. This enables the WebDAV server
Valid options are off and on. Defaults to off
Give a port for the ICP server. This enables the ICP server.
Sets the clienthome for the generated instance. Defaults to ${buildout:directory}/var/<name of the section>.
Used to configure the base directory for all things going into var. Defaults to ${buildout:directory}/var.
The filename of the event log. Defaults to var/log/${partname}.log
A custom section for the eventlog, to be able to use another event logger than logfile
Set the level of the console output for the event log. Level may be any of CRITICAL, ERROR, WARN, INFO, DEBUG, or ALL. Defaults to INFO.
The filename for the Z2 access log. Defaults to var/log/${partname}-Z2.log.
Set the log level for the access log. Level may be any of CRITICAL, ERROR, WARN, INFO, DEBUG, or ALL. Defaults to WARN.
Like event-log-custom, a custom section for the access logger, to be able to use another event logger than logfile.
The filename where the ZODB data file will be stored. Defaults to var/filestorage/Data.fs.
If 'on' it enables the demostorage. It is not compatible with blob-storage and rel-storage.
The name of the directory where the ZODB blob data will be stored.

Allows to set a RelStorage instead of a FileStorage.

Contains settings separated by newlines, with these values:

  • type: any database type supported (postgresql, oracle, mysql)
  • RelStorage specific keys, like cache-servers and poll-interval
  • all other keys are passed on to the database-specific RelStorage adapter.


rel-storage =
  type oracle
  user tarek
  password secret
Set to 'on' to make this instance a ZEO client. In this case, setting the zeo-address option is required, and the file-storage option has no effect. To set up a ZEO server, you can use the plone.recipe.zope2zeoserver recipe. Defaults to 'off'.
If 'zeo-client' is set to 'on' and 'blob-storage' is set to a directory that is shared between this instance and the ZEO server (as configured by the 'blob-dir' setting on zeo.conf, then setting 'shared-blob' to 'on' causes this instance not to stream the blob file through the ZEO connection, but just to send the information of the file location to the ZEO server.
Set the address of the ZEO server. Defaults to 8100.
Set the name of the ZEO client. Defaults to the name of the part. If a false value is provided no zeo-client-name will be set.
Set the size of the ZEO client cache. Defaults to '30MB'.
Set the persistent cache name that is used to construct the cache filenames. Persistent cache files are disabled by default.
Set the storage number of the ZEO storage. Defaults to '1'.
Used in the zeo storage snippets to configure the zeo var folder. Defaults to $INSTANCE_HOME/var.
Enable ZEO authentication and use the given username when accessing the ZEO server. It is obligatory to also specify a zeo-password.
Password to use when connecting to a ZEO server with authentication enabled.
Authentication realm to use when authentication with a ZEO server. Defaults to 'ZEO'.
Set the ZODB cache size, i.e. the number of objects which the ZODB cache will try to hold. Defaults to 5000.
Set the ZODB cache sizes in bytes. Requires ZODB 3.9 or later.
Specify the number of threads that Zope's ZServer web server will use to service requests. You shouldn't change this unless you know what you are doing. Zope's default is 4.
If given Zope's default temporary storage definition will be replaced by the lines of this parameter.

Define arbitrary key-value pairs for use as environment variables during Zope's run cycle.


environment-vars =
  TZ US/Eastern
  TMP /var/tmp

Give additional lines to zope.conf. Make sure you indent any lines after the one with the parameter.


zope-conf-additional =
  locale fr_FR
  http-realm Slipknot
Set this to true to make the generated scripts use relative paths. You can also enable this in the [buildout] section.
The traditional way to run Zope is by using shell scripts. These in turn start-up a Python process with the right settings. By setting this option to true (default false) these shell scripts will not be used. In this case the recipe will directly start the Python process.