Package: isotoma.recipe.zeo
OverviewThis recipe creates and configures a ZEO server in parts. It also installs a
control script in the bin/ directory. The name of the control script is the
name of the part in buildout.You can use it with a part like this:[zeo]
recipe = plone.recipe.zeoserver
zeo-address = 8100This will create a control scriptbin/zeo.You can either start the database in foreground mode viabin/zeo fgor use
the built-in zdaemon process control and use thestart/stop/restart/statuscommands. The foreground mode is suitable for running the process under general
process control software like supervisord.Note: Windows support for this recipe is currently limited.OptionsThe following options all affect the generated zeo.conf. If you want to have
full control over the configuration file, see thezeo-confoption in the
advanced options.Processzeo-addressGive a port for the ZEO server (either specify the port number only (with
‘127.0.0.1’ as default) or you use the formathost:port).
Defaults to8100.effective-userThe name of the effective user for the ZEO process. Defaults to not setting
an effective user. This causes the process to run under the user account the
process has been started with.socket-nameThe filename where ZEO will write its socket file.
Defaults tovar/zeo.zdsock.Storagestorage-numberThe number used to identify a storage. Defaults to1.file-storageThe filename where the ZODB data file will be stored.
Defaults tovar/filestorage/Data.fs.blob-storageThe folder where the ZODB blob data files will be stored.
Defaults tovar/blobstorage.Loggingzeo-logThe filename of the ZEO log file. Defaults tovar/log/${partname}.log.zeo-log-formatFormat of logfile entries. Defaults to%(asctime)s %(message)s.zeo-log-customA custom section for the eventlog, to be able to use another
event logger thanlogfile.zeo-logis still used to set the logfile
value in the runner section.Authenticationauthentication-databaseThe 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-realmThe authentication realm. Defaults toZEO.Packingpack-daysHow many days of history should the zeopack script retain. Defaults to
one day.pack-gcCan be set tofalseto disable garbage collection as part of the pack.
Defaults totrue.pack-keep-oldCan be set tofalseto disable the creation of*.fs.oldfiles before
the pack is run. Defaults totrue.pack-userIf the ZEO server uses authentication, this is the username used by the
zeopack script to connect to the ZEO server.pack-passwordIf the ZEO server uses authentication, this is the password used by the
zeopack script to connect to the ZEO server.Monitoringmonitor-addressThe address at which the monitor server should listen. The monitor server
provides server statistics in a simple text format.Performanceinvalidation-queue-sizeThe invalidation-queue-size used for the ZEO server. Defaults to100.Customizationzeo-conf-additionalGive additional lines to zeo.conf. Make sure you indent any lines after
the one with the parameter. This allows you to use generated zeo.conf file
but add some minor additional lines to it.eggsSet 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).extra-pathsSpecify additional directories which should be available to the control
scripts. Use this only for non-eggified Python packages.zeo-confA relative or absolute path to a zeo.conf file. This lets you provide a
completely custom configuration file and ignore most of the options in
this recipe.repozoThe 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 using the repozo script from the ZODB3 egg.
Set this to an empty value if you do not want this script to be generated.zeopackThe 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 using the zeopack script from the ZODB3 egg.
Set this option to an empty value if you do not want this script to be
generated.relative-pathsSet this totrueto make the generated scripts use relative
paths. You can also enable this in the[buildout]section.UsagezeopackA zeopack script will be generated for you in the buildout bin directory.
If you’d like to use this script to pack a different mount point, you’ll
need to specify-S mount_name. You can also specify a-Boption to not
use the default blob directory.Reporting bugs or asking questionsWe have a shared bugtracker and help desk on Launchpad:https://bugs.launchpad.net/collective.buildout/Changelog2.0.4 (2011-11-15)Add files missing from sdist2.0.3 (2011-11-14)Fix a versioning mishap2.0.2 (2011-11-14)Add a list of imports for monkey patch injection:[zeoserver]
eggs = isotoma.zope.groupreadableblobstorage
import = isotoma.zope.groupreadableblobstorage2.0.0 - 2011-03-08Friendly fork to patch sys.path behaviour in our deployments.1.2.0 - 2010-10-18Only require ant_svcutilsdistribution on Windows.
[hannosch]1.1.1 - 2010-07-20Fixed -B option being required for along with the -S option.
[vangheem]Added documentation for using the zeopack script with mount points.
[vangheem]1.1 - 2010-07-18No changes.1.1b1 - 2010-07-02Implemented Windows support and support for running ZEO as a Windows service.
We depend on the new nt_svcutils distribution to provide this support.
[baijum, hannosch]The FileStorage component of ZODB 3.9 now supports blobs natively,
so no need to use BlobStorage proxy for it anymore.
[baijum, hannosch]Addedextra-pathsoption to add additional modules paths.
[baijum]Fixed ZEO packing of mounted storage.
[vangheem]Added -B option to thezeopackscript to specify the location of the
blob storage.
[vangheem]1.1a2 - 2010-05-10Added support for thepack-keep-oldoption introduced in ZODB 3.9.
[hannosch]1.1a1 - 2010-04-27Added support for thepack-gcoption introduced in ZODB 3.9.
[hannosch]Always create a blob-storage by default.
[hannosch]Require at least ZODB 3.8 and simplify thezeopackscript.
[hannosch]Various documentation updates.
[hannosch]Use the newzope.mkzeoinstancepackage, which makes the recipe compatible
with ZODB 3.9.5+.
[hannosch]Removed unmaintained win32 specific tests and old zope2 test mockups.
[hannosch]Removed testing dependency onzope.testingand refactored testing setup.
[hannosch]1.0 - 2010-04-05Depend on and always include ZopeUndo. While it’s only needed for Zope 2, the
distribution is so tiny, it doesn’t hurt for non-Zope 2 ZEO servers.
[hannosch]1.0b1 - 2010-03-19Fixed issue with egg paths for the zeopack script.
[davisagli]Added support for setting ZEO log level.
[baijum]1.0a2 - 2009-12-03Set up logging configuration that is needed by ZODB.blob.
[davisagli]Set shared_blob_dir to True when initializing the ClientStorage used
by the pack script, since it will be using the same blob directory
as the ZEO server.
[davisagli]1.0a1 - 2009-12-03Updated and cleaned up after renaming.
[hannosch]Added compatibility with eggified Zopes (Zope >= 2.12).
[davisagli]Initial implementation based on plone.recipe.zope2zeoserver.
[plone]