This repository is archived and read only.

If you want to unarchive it, then post to the [Admin & Infrastructure (AI) Team category on the Plone Community Forum](https://community.plone.org/c/aiteam/55).

plone.recipe.zope2zeoserver

This recipe creates and configures a Zope 2 ZEO server in parts. It also installs a control script, which is like zeoctl, 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:

[zeoserver]
recipe = plone.recipe.zope2zeoserver
zope2-location = /path/to/zope2/install
zeo-address = 8100

Attention

This recipe works with Zope 2 versions prior to Zope 2.12 or ZODB3 versions prior to ZODB 3.8. If you want to use newer versions of any of the two (for example for Plone 4) please use the plone.recipe.zeoserver: recipe instead.

Options

zope2-location

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 zope2zeoserver part, you can use ${zope2:location} for this parameter. You must ensure the zope2zeoserver part is run after the zope2install one.

zeopack

The path to the zeopack.py backup script. A wrapper for this will be generated in bin/zeopack, which sets up the appropriate environment to run this. Defaults to "${zope2-location}/utilities/ZODBTools/zeopack.py". Set this option to an empty value if you do not want this script to be generated.

zeopack-script-name

The name of the generated zeopack script in the context of the bin directory. Defaults to "zeopack".

repozo

The path to the repozo.py 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/repozo.py". Set this to an empty value if you do not want this script to be generated.

repozo-script-name

The name of the generated repozo script in the context of the bin directory. Defaults to "repozo"

zeo-conf

A relative or absolute path to a zeo.conf file. If this is not given, a zeo.conf will be generated based on the the options below.

The following options all affect the generated zope.conf.

zeo-address

Give a port for the ZEO server (either specify the port number only (with 'localhost' as default) or you use the format host:port). Defaults to 8100.

effective-user

The name of the effective user for the ZEO process. Defaults to not setting an effective user.

invalidation-queue-size

The invalidation-queue-size used for the ZEO server. Defaults to 100.

zeo-log

The filename of the ZEO log file. Defaults to var/log/${partname}.log

zeo-log-format

Format of logfile entries. Defaults to %(asctime)s %(message)s

zeo-log-custom

A custom section for the eventlog, to be able to use another event logger than logfile. zeo-log is still used to set the logfile value in the runner section.

storage-number

The number used to identify a storage.

file-storage

The filename where the ZODB data file will be stored. Defaults to var/filestorage/Data.fs.

blob-storage

The folder where the ZODB blob data files will be stored.

socket-name

The filename where ZEO will write its socket file. Defaults to var/zeo.zdsock.

authentication-database

The filename for a authentication database. Only accounts listed in this database will be allowed to access the ZEO server.

The format of the database file is:

realm <realm>
<username>:<hash>

Where the hash is generated via:

import sha
string = "%s:%s:%s" % (username, realm, password)
sha.new(string).hexdigest()

authentication-realm

The authentication realm. Defaults to 'ZEO'

pack-days

Specify of days for the zeopack script to retain of history. Defaults to one day.

pack-user

If the ZEO server uses authentication, this is the username used by the zeopack script to connect to the ZEO server.

pack-password

If the ZEO server uses authentication, this is the password used by the zeopack script to connect to the ZEO server.

zeo-conf-additional

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

monitor-address

The address at which the monitor server should listen. The monitor server provides server statistics in a simple text format.

relative-paths

Set this to true to make the generated scripts use relative paths. You can also enable this in the [buildout] section.

eggs

Set if you need to include other packages as eggs e.g. for making application code available on the ZEO server side for performing conflict resolution (through the _p_resolveConflict() handler).

read-only

Set it to true if you want to put the ZEO server in read-only mode. No modifications will be made on the Data.fs.

Reporting bugs or asking questions

We have a shared bugtracker and help desk on Launchpad: https://bugs.launchpad.net/collective.buildout/