{ "info": { "author": "John Carr", "author_email": "john.carr@isotoma.com", "bugtrack_url": null, "classifiers": [ "Framework :: Buildout", "Intended Audience :: System Administrators", "License :: OSI Approved :: Zope Public License", "Operating System :: POSIX" ], "description": "Introduction\n============\n\nThis is a temporary fork of plone.recipe.zope2instance that has slightly\ntweaked exit code handling. Unless you need this, we suggest using the\nupstream recipe.\n\nThis recipe creates and configures a Zope 2 instance in parts. It also\ninstalls a control script, which is like zopectl, in the bin/ directory.\nThe name of the control script is the the name of the part in buildout.\n\nYou can use it with a part like this::\n\n [instance]\n recipe = isotoma.recipe.zope2instance\n zope2-location = /path/to/zope2/install\n user = admin:admin\n http-address = 8080\n eggs = ${buildout:eggs} my.package\n products = ${buildout:directory}/products\n zcml = my.package\n\nOptions\n-------\n\nzope2-location\n The path where Zope 2 is installed. If you are also using the\n plone.recipe.zope2install recipe, and you have that configured as a part\n called 'zope2' prior to the zope2instance part, you can use ${zope2:location}\n for this parameter.\n\nzope-conf\n A relative or absolute path to a zope.conf file. If this is not given, a\n zope.conf will be generated based on the the options below.\n\nrepozo\n The path to the repozo.py backup script. A wrapper for this will be\n generated in bin/repozo, which sets up the appropriate environment for\n running this. Defaults to \"${zope2-location}/utilities/ZODBTools/repozo.py\".\n Set this to an empty value if you do not want this script to be generated.\n\nThe following options all affect the generated zope.conf:\n\nproducts\n A list of paths where Zope 2 products are installed. The first path takes\n precedence in case the same product is found in more than one directory.\n\nsite-zcml\n If you want a custom site.zcml file, put its content here. If this option is\n used the zcml and zcml-additional options are ignored.\n\nzcml\n Install ZCML slugs for the packages listed, separated by whitespace. You\n can specify the type of slug by appending '-' and the type of slug you want\n to create. The valid types are configure, overrides and meta. Some\n examples: my.package-overrides my.package-meta\n\nzcml-additional\n Extra ZCML statements that should be included in the generated site.zcml\n file.\n\nextra-paths\n A list of paths where additional python packages are installed. The paths\n are searched in the given order after all egg and products paths.\n\ndefault-zpublisher-encoding\n This controls what character set is used to encode unicode data that reaches\n ZPublisher without any other specified encoding. This defaults to 'utf-8'.\n\ndebug-mode\n Set to 'on' to turn on debug mode in Zope. Defaults to 'off'.\n\nverbose-security\n Set to 'on' to turn on verbose security (and switch to the Python security\n implementation). Defaults to 'off' (and the C security implementation).\n\neffective-user\n The name of the effective user for the Zope process. Defaults to not setting\n an effective user.\n\nip-address\n The default IP address on which Zope's various server protocol\n implementations will listen for requests. If this is unset, Zope will listen\n on all IP addresses supported by the machine. This directive can be\n overridden on a per-server basis in the servers section. Defaults to not\n setting an ip-address.\n\nport-base\n Offset applied to the port numbers used for ZServer configurations. For\n example, if the http-server port is 8080 and the port-base is 1000, the HTTP\n server will listen on port 9080. This makes it easy to change the complete\n set of ports used by a Zope server process. Zope defaults to 0.\n\nhttp-address\n Give a port for the HTTP server. Defaults to 8080.\n\nhttp-fast-listen\n Set to off to defer opening of the HTTP socket until the end of the Zope\n startup phase. Defaults to on. Note: This option requires Zope >= 2.11.\n\nftp-address\n Give a port for the FTP server. This enables the FTP server.\n\nwebdav-address\n Give a port for the WebDAV server. This enables the WebDAV server\n\nwebdav-force-connection-close\n Valid options are off and on. Defaults to off\n\nicp-address\n Give a port for the ICP server. This enables the ICP server.\n\nclient-home\n Sets the clienthome for the generated instance.\n Defaults to ${buildout:directory}/var/.\n\nvar\n Used to configure the base directory for all things going into var.\n Defaults to ${buildout:directory}/var.\n\nevent-log\n The filename of the event log. Defaults to var/log/${partname}.log\n\nevent-log-custom\n A custom section for the eventlog, to be able to use another\n event logger than `logfile`\n\nevent-log-level\n Set the level of the console output for the event log. Level may be any of\n CRITICAL, ERROR, WARN, INFO, DEBUG, or ALL. Defaults to INFO.\n\nz2-log\n The filename for the Z2 access log. Defaults to var/log/${partname}-Z2.log.\n\nz2-log-level\n Set the log level for the access log. Level may be any of CRITICAL, ERROR,\n WARN, INFO, DEBUG, or ALL. Defaults to WARN.\n\naccess-log-custom\n Like `event-log-custom`, a custom section for the access logger, to be able\n to use another event logger than `logfile`.\n\nfile-storage\n The filename where the ZODB data file will be stored.\n Defaults to var/filestorage/Data.fs.\n\ndemo-storage\n If 'on' it enables the demostorage. It is not compatible with blob-storage\n and rel-storage.\n\nblob-storage\n The name of the directory where the ZODB blob data will be stored.\n\nrel-storage\n Allows to set a RelStorage instead of a FileStorage.\n\n Contains settings separated by newlines, with these values:\n\n - type: any database type supported (postgresql, oracle, mysql)\n - RelStorage specific keys, like `cache-servers` and `poll-interval`\n - all other keys are passed on to the database-specific RelStorage adapter.\n\n Example::\n\n rel-storage =\n type oracle\n dsn (DESCRIPTION=(ADDRESS=(HOST=s01))(CONNECT_DATA=(SERVICE_NAME=d01)))\n user tarek\n password secret\n\nzeo-client\n Set to 'on' to make this instance a ZEO client. In this case, setting the\n zeo-address option is required, and the file-storage option has no effect.\n To set up a ZEO server, you can use the plone.recipe.zope2zeoserver recipe.\n Defaults to 'off'.\n\nshared-blob\n If 'zeo-client' is set to 'on' and 'blob-storage' is set to a directory that\n is shared between this instance and the ZEO server (as configured by the\n 'blob-dir' setting on zeo.conf, then setting 'shared-blob' to 'on' causes\n this instance not to stream the blob file through the ZEO connection, but\n just to send the information of the file location to the ZEO server.\n\nzeo-address\n Set the address of the ZEO server. Defaults to 8100.\n\nzeo-client-name\n Set the name of the ZEO client. Defaults to the name of the part. If a false\n value is provided no zeo-client-name will be set.\n\nzeo-client-cache-size\n Set the size of the ZEO client cache. Defaults to '30MB'.\n\nzeo-client-client\n Set the persistent cache name that is used to construct the cache\n filenames. Persistent cache files are disabled by default.\n\nzeo-storage\n Set the storage number of the ZEO storage. Defaults to '1'.\n\nzeo-var\n Used in the zeo storage snippets to configure the zeo var folder.\n Defaults to $INSTANCE_HOME/var.\n\nzeo-username\n Enable ZEO authentication and use the given username when accessing the\n ZEO server. It is obligatory to also specify a zeo-password.\n\nzeo-password\n Password to use when connecting to a ZEO server with authentication\n enabled.\n\nzeo-realm\n Authentication realm to use when authentication with a ZEO server. Defaults\n to 'ZEO'.\n\nzodb-cache-size\n Set the ZODB cache size, i.e. the number of objects which the ZODB cache\n will try to hold. Defaults to 5000.\n\nzodb-cache-size-bytes\n Set the ZODB cache sizes in bytes. Requires ZODB 3.9 or later.\n\nzserver-threads\n Specify the number of threads that Zope's ZServer web server will use to\n service requests. You shouldn't change this unless you know what you are\n doing. Zope's default is 4.\n\nzodb-temporary-storage\n If given Zope's default temporary storage definition will be replaced by\n the lines of this parameter.\n\nenvironment-vars\n Define arbitrary key-value pairs for use as environment variables during\n Zope's run cycle.\n\n Example::\n\n environment-vars =\n TZ US/Eastern\n TMP /var/tmp\n DISABLE_PTS True\n\nzope-conf-additional\n Give additional lines to zope.conf. Make sure you indent any lines after\n the one with the parameter.\n\n Example::\n\n zope-conf-additional =\n locale fr_FR\n http-realm Slipknot\n\nrelative-paths\n Set this to `true` to make the generated scripts use relative\n paths. You can also enable this in the `[buildout]` section.\n\nno-shell\n The traditional way to run Zope is by using shell scripts. These in\n turn start-up a Python process with the right settings. By setting\n this option to true (default false) these shell scripts will not be\n used. In this case the recipe will directly start the Python\n process.\n\n\nChangelog\n=========\n\n3.6 (2009-10-11)\n----------------\n\n- Expanded the RelStorage options, including keep-history and replica-conf.\n [hathawsh]\n\n3.5 (2009-09-05)\n----------------\n\n- Added support for relative-paths in the script generation.\n [jvloothuis]\n\n- When `zope-conf` is set the config file will be directly loaded from that\n location (it previously created a stub zope.conf which included it).\n [jvloothuis]\n\n- Added an option to avoid using the normal shell scripts for starting Zope.\n This makes it possible to avoid the hard-coded paths in these scripts.\n [jvloothuis]\n\n- Allow the blob-dir parameter in RelStorage configurations.\n [hathawsh]\n\n3.4 (2009-08-12)\n----------------\n\n- Support in line with fix for LP#407916.\n [gotcha]\n\n- Changed the 'mkzopeinstance' call respect the 'bin-directory' option.\n [esteele]\n\n- Removed the `zope2-egg` option and the simple startup script from the recipe.\n We assume that we have an egg distribution if `zope2-location` is not set.\n [hannosch]\n\n- Merged the `davisagli-eggified-zope` branch into the trunk.\n [hannosch]\n\n- Add a new icp-address option. This is useful for environments where\n e.g. squid is used to front a Zope/ZEO cluster. See\n http://www.zope.org/Members/htrd/icp/intro\n [neaj]\n\n3.3 - 2009-07-07\n----------------\n\n- Add handling for RelStorage options.\n [elro]\n\n- Reinstall scripts on update which appears to be good recipe practice.\n [stefan]\n\n3.2 - 2009-04-02\n----------------\n\n- Add a new zcml-additional option. This is useful for environments where\n non-code configuration (such as database connection details for\n ore.contentmirror) are managed through zcml.\n [wichert]\n\n3.1 (2009-03-15)\n----------------\n\n- The 2.9 fix for spaces caused a problem using debug (bug 337740)\n due to the way do_debug passed the \"-i\" command line argument\n to get_startup_cmd.\n [smcmahon]\n\n3.0 (2009-02-27)\n----------------\n\n- The 2.9 fix for the instance run command was itself broken and\n would fail on anything except Windows.\n [smcmahon]\n\n- Changed the `zope2-egg` option to omit any kind of instance creation for\n now. The mkzopeinstance script relies on being able to import Zope2, which\n is not available when buildout runs.\n [hannosch]\n\n2.9 (2009-02-26)\n----------------\n\n- The instance run command was vulnerable to spaces in pathnames, and\n needed some extra quoting for win32.\n [smcmahon]\n\n- Check for existence of windows scripts before patching them. Some\n Linux distributions of Zope2 don't have these files.\n [smcmahon]\n\n- Delegate commands to ``win32serviceutil.HandleCommand()`` on win32,\n instead of starting the interpreter through ``os.system()``. Should\n shave off a couple seconds from overall time taken to process those\n commands.\n [sidnei]\n\n- Compute ``serviceClassString`` ourselves, since we are calling this\n as a module and not directly as ``__main__``, otherwise the service\n won't be installed correctly.\n [sidnei]\n\n2.8 (2008-12-05)\n----------------\n\n- Add more tests for ZEO client with blob and demo storages.\n Still no test on 'shared-blob-dir' option.\n [encolpe]\n\n- Always use 'r'-style strings for passing script and configuration\n filenames (eg: on 'instance run