跳转到主要内容

用于创建和更新Plone站点的buildout食谱

项目描述

简介

此食谱允许您在buildout运行过程中创建和更新Plone站点。此食谱仅旨在运行配置文件和Quickinstall产品。假设安装方法、设置处理程序、升级步骤和其他食谱将处理其他工作。

详细文档

选项

常规设置

site-id

脚本将创建的Plone站点的id。创建站点后也将用于更新站点。默认:Plone

admin-user

将用作管理员的admin用户的id。默认:admin

admin-password

admin用户的密码。当设置了use_vhm选项且站点的根对象不可由匿名访问时,此选项是必需的。

instance

将运行脚本的实例的名称。默认:instance

zeoserver

应使用的zeoserver部分的名称。如果您使用的是zope/zeo设置,则需要此选项。默认:不设置

container-path

容器应持有的Plone站点的路径(从Zope根目录相对路径)。默认:/

default-language

Plone站点的默认语言。默认:en

use-sudo

在指定于相应实例的buildout部分的用户下运行任务。您需要适当配置sudo。

add-mountpoint

如果不存在,则在由container-path指定的路径上添加ZODB挂载点。当与collective.recipe.filestorage一起使用时非常有用。

日志记录

此配方尊重log-level buildout-level配置值和verbosity设置,覆盖运行Zope实例的eventlog级别。这允许您在运行部分时获得更多日志输出,但在站点实际运行时具有更少的冗余。

安装产品

弃用通知:在Plone 6中安装产品已被弃用,因为它不再具有快速安装器:请使用配置文件代替。

products-initial

在初始站点创建后快速安装的产品列表。有关产品名称格式信息,请参阅上文。

profiles-initial

在初始站点创建后运行的GenericSetup配置文件列表。有关预期配置文件id格式信息,请参阅上文。

products

每次运行buildout时快速安装的产品列表。有关产品名称格式信息,请参阅上文。

profiles

每次运行buildout时运行的GenericSetup配置文件列表。有关预期配置文件id格式信息,请参阅上文。

运行脚本

预额外配置

指向包含要评估的Python代码的文件的绝对路径,这些代码将在运行快速安装器和通用设置配置文件之前执行。可以提供多个文件。您将有两个可用的变量。app变量是Zope根。portal变量是定义为site-id选项的plone站点。注意:文件路径不能包含空格。默认:未设置

后额外配置

指向包含要评估的Python代码的文件的绝对路径,这些代码将在运行快速安装器和通用设置配置文件之后执行。可以提供多个文件。您将有两个可用的变量。app变量是Zope根。portal变量是定义为site-id选项的plone站点。注意:文件路径不能包含空格。默认:未设置

安装前

在安装Plone之前执行的系统命令。您可以使用此选项启动一个Supervisor守护进程以启动ZEO,而不是直接启动ZEO。您可以用此选项代替zeoserver选项。默认:未设置

安装后

安装Plone后执行的系统命令。默认:未设置

升级

升级门户

通过运行站点基本通用设置配置文件的所有升级步骤来将站点升级到文件系统上的当前版本。需要安装collective.upgrade。默认:false

升级所有配置文件

通过运行所有升级步骤来将站点上安装的所有通用设置配置文件升级到其文件系统上的当前版本。需要安装collective.upgrade。默认:false

升级配置文件

在每次运行buildout时运行升级步骤的通用设置配置文件列表。升级在profiles-initial之后和profiles之前运行。有关预期的配置文件ID格式信息,请参阅上面[1]。需要安装collective.upgrade

替换站点

替换任何现有的名为site-id的plone站点。默认:false

启用

启动实例/zeoserver的选项。默认:true。如果您不想启动Zope,但仍然想运行完整的buildout,这是一个有用的命令行选项。

$ bin/buildout -Nv plonesite:enabled=false

VHM(虚拟主机怪物)

主机

用于VirtualHostMonster遍历的主机名。这将设置任何pre-extraspost-extras脚本中portal变量的根URL。默认:未设置

协议

用于VirtualHostMonster路径的‘http’或‘https’。需要设置主机选项。默认:http

端口

用于VirtualHostMonster路径的Zope站点的端口。需要设置主机选项。默认:80

使用vhm

指示Plone站点在生成请求时是否应使用VirtualHostMonster或普通Zope遍历。对于不会在Apache或Nginx后端代理的实例(例如本地开发),这是一个有用的选项。默认:True

示例

这是一个包含plonesite食谱的示例buildout.cfg

[buildout]
parts =
    zope2
    instance
    zeoserver
    plonesite

[zope2]
recipe = plone.recipe.zope2install
...

[instance]
recipe = plone.recipe.zope2instance
...
eggs =
    ...
    my.package
    my.other.package

zcml =
    ...
    my.package
    my.other.package

[zeoserver]
recipe = plone.recipe.zope2zeoserver
...

[plonesite]
recipe = collective.recipe.plonesite
site-id = test
instance = instance
zeoserver = zeoserver
# A profile with proper upgrade steps
profiles-initial = addon.package:default
profiles =
# A profile not using upgrade steps, such as a simple policy package
    my.package:default
upgrade-portal = True
upgrade-all-profiles = True
post-extras =
    ${buildout:directory}/my_script.py
pre-extras =
    ${buildout:directory}/my_other_script.py
host = www.mysite.com
protocol = https
port = 443

启用Plone 4内容的示例

这是一个包含plone4site食谱的另一个示例buildout.cfg

[buildout]
parts =
    ...
    plone4site

[plone4site]
recipe = collective.recipe.plonesite
site-id = test
instance = instance
zeoserver = zeoserver
# Create default plone content like News, Events...
profiles-initial =
    Products.CMFPlone:plone-content
    my.package:initial
profiles =
    my.package:default
    my.other.package:default

多挂载点示例

这使用collective.recipe.filestorage创建挂载点配置

[buildout]
parts =
    filestorage
    instance
    zeoserver
    plonesite1
    plonesite2

[filestorage]
recipe = collective.recipe.filestorage
parts =
    mp1
    mp2

[instance]
recipe = plone.recipe.zope2instance
...
eggs =
    ...
    my.package
    my.other.package

zcml =
    ...
    my.package
    my.other.package

[zeoserver]
recipe = plone.recipe.zope2zeoserver
...

[plonesite1]
recipe = collective.recipe.plonesite
add-mountpoint = true
container-path = /mp1
profiles-initial = Products.CMFPlone:plone-content
site-id = portal

[plonesite2]
recipe = collective.recipe.plonesite
add-mountpoint = true
container-path = /mp2
profiles-initial = Products.CMFPlone:plone-content
site-id = portal

贡献者

  • Clayton Parker [claytron],作者

  • Andrew Burkhalter [andrewb]

  • JeanMichel FRANCOIS [toutpt]

  • Andreas Jung [ajung]

  • Jeff Kowalczyk [jeffk]

  • Pelle Krogholt [pelle]

  • Michael Davis [davismr]

  • Nolan Brubaker [nrb]

  • David Blewett [davidblewett]

  • Toni Mueller [muellert]

  • Fabio Rauber [fabiorauber]

  • 布莱恩·威尔逊 [bryanlandia]

  • 克里斯蒂·韦恩赖特 [cdw9]

  • 维克托·费尔南德斯·德·阿尔巴 [sneridagh]

变更历史

1.12.0 (2021-03-06)

  • 增加与Plone 6的兼容性 [sneridagh]

1.11.0 (2019-03-20)

  • 修复brownbag发布 [sneridagh]

1.10.0 (2019-03-20)

  • Python3兼容性 [sneridagh]

1.9.5 (2016-06-22)

  • 对于GenericSetup 1.8.0+,将runAllImportStepsFromProfile设置为重新应用依赖配置文件。这将使我们的buildouts运行如预期,每次运行策略的metadata.xml中列出的配置文件 [cdw9]

1.9.4 (2016-01-20)

  • 没有新内容,但pypi在1.9.3版本中存在问题

1.9.3 (2016-01-15)

  • Plone 5兼容性 [santonelli]

1.9.2 (2015-06-22)

  • 仅使用有效的Python日志级别。如果传入的值不存在,则向上取整到最接近的级别。 [claytron]

1.9.1 (2014-12-01)

  • 当主页无法通过<匿名>访问时,通过设置选项启用功能。 [claytron]

  • PEP8和pyflakes [claytron]

  • 恢复Python 2.4兼容性 [bryanlandia]

  • Plone 5兼容,重新使用添加站点表单默认配置文件逻辑。 [@rpatterson]

1.9.0 (2014-08-29)

  • 添加选项,如果不存在,将自动创建挂载点。 [fabiorauber]

  • 如果安装了collective.upgrade,则添加运行配置文件升级步骤的选项。 [@rpatterson]

  • 如果为Zope和ZEO服务器指定了不同的UID,则添加允许使用sudo的选项。 [muellert]

  • 整理文档并按标题分隔选项。 [claytron]

1.8.2 (2013-04-08)

  • 处理Plone 4.3的导入 [claytron]

1.8.1 (2012-11-16)

  • 为1.8.90版本添加变更日志条目 [nrb]

1.8.0 (2012-11-16)

  • 添加选项以选择遍历模式。将设置为False将导致在运行配方时使用常规Zope遍历。 [nrb]

1.7.3 (2012-11-02)

  • 使用<_delObject(site_id, suppress_events=True)>来删除站点。这将忽略所有事件,并在使用选项时完全删除站点。 [claytron]

1.7.2 (2012-08-06)

  • 在删除现有Plone站点时修复了日志记录器中的拼写错误。 [hvelarde]

1.7.1 (2012-07-13)

  • 添加在部分运行时更改日志级别的选项,以尊重buildout的日志级别和详细程度。 [davidblewett]

  • 更新版本检查以正确区分Plone 4.1.x和Plone 4.0及以下版本。 [davidblewett]

1.6.3 (2012-07-03)

  • 更新VirtualHostMonster支持以纠正提升的安全上下文丢失。 [davidblewett]

1.6.1 (2012-06-27)

  • 修复reST格式化。 [nrb]

  • 纠正一些文档疏忽。 [nrb]

1.6 (2012-06-26)

  • 为在脚本中可用的‘portal’变量添加VirtualHostMonster路径支持。 [nrb]

  • 配方选项指定在VirtualHostMonster路径中使用的域名,用于额外的配方脚本。 [nrb]

  • 配方选项指定在VirtualHostMonster路径中使用的端口号,用于额外的配方脚本。 [nrb]

  • 配方选项指定从额外的配方脚本中使用的协议,用于VirtualHostMonster路径。 [nrb]

  • 在文档中修复了拼写错误。 [hvelarde]

  • 配方选项指定Plone站点将被添加到的容器路径。 [gotcha]

  • 配方选项指定Plone站点的默认语言。 [sgeulette]

1.5 (2011-09-22)

  • 支持。 [gotcha]

  • 支持Plone 4.1 [gotcha]

1.4.3 (2011-07-07)

  • 轻微的文档更新。 [claytron]

1.4.2 (2011-07-07)

  • 发布到plone.org [claytron]

  • 文档更新。 [claytron]

1.4.1 (2011-02-15)

  • 轻微的文档更新 [claytron]

1.4 (2011-02-15)

  • PEP8清理 [claytron]

  • 处理Windows上新的zeoserver配方,它更改了可执行文件名称。 [claytron]

  • 请使用 plone 变量而不是 portal,否则在新的安装中 plonesite.py 会抛出 NameError: global name 'portal' is not defined。 [pelle]

  • 启用 GS 配置文件以在 plone 2.5 中工作 [davismr]

  • 在初始创建中也使用 setSite。 [claytron]

1.3 (2010-02-11)

  • plonesite`.py` 脚本中使用 setSite,以确保组件架构被正确初始化。这将允许安装如 ``plone.app.dexterity 这样的产品 [clayton]

1.2 (2010-02-10)

  • 更新文档,添加有关如何添加 Product 的信息 [claytron]

  • 由于 addPloneSite() 有所变化,已调整对 Plone4 的支持 [pelle]

1.1 (2009-11-10)

  • 确保在添加 plone 站点后提交事务,以避免一些奇怪的行为 [claytron]

  • 添加对 Plone4 的支持 [toutpt]

1.0 (2009-08-24)

  • before-installafter-install 选项添加到配方中。这允许您使用类似 supervisor 的事物来启动进程。感谢 Shane Hathaway 提供的补丁。 [claytron]

0.9 (2009-08-10)

  • 已修复 site-id 选项,使其默认为 Plone。感谢 aclark 提供的错误报告。 [claytron]

0.8 (2009-06-24)

  • Subversion 1.6 和 setuptools 还不是朋友。已修复上传。 [claytron]

0.7 (2009-06-23)

  • 对文档进行说明。清理复制粘贴错误到 post-extras [andrewb]

  • 修复了 instance 选项,使其默认为 instance。 [claytron]

0.6 (2008-12-16)

  • 根据文档,将 admin-user 配置选项真正设置为可选。回退到 admin,这是 ZopeSkel 的 plone3_buildout 模板中的常见默认值 [andrewb]

  • 添加了新的选项 pre-extraspost-extras。这两个选项是可以在快速安装器和配置文件运行前后运行的文件。 [claytron]

  • 添加条件,使脚本可用于较旧的 plone 版本 [claytron]

0.5 (2008-11-11)

  • 修复了一个问题,其中已安装的产品不会重新安装 [claytron]

  • 添加了示例 buildout 配置并更新了 READMEs [claytron]

  • 重构了 plonesite.py 脚本 [claytron]

  • 一些 PEP 8 的调整 [claytron]

0.4 (2008-11-11)

  • 添加了一个 enabled 选项,这样您就可以从命令行关闭部分。 (buildout:parts-=plonesite 还不起作用) [claytron]

  • 修改脚本,以便也可以提供以 profile- 前缀开头的配置文件 [claytron]

  • 为配方添加了一些文档 [claytron]

0.3 (2008-10-30)

  • 在 README 中添加了 site-replace 选项 [claytron]

  • 不再需要 site-replace 选项 [claytron]

0.2 (2008-10-30)

  • 新 Plone 站点将创建具有 datetime 后缀,这在需要反复运行新实例时很有用,例如用于迁移目的。如果您需要固定的站点 ID,则请使用 site-id 选项显式设置 ID。 [ajung]

  • 修复了未初始化变量的错误 [jeffk]

  • 添加 buildout 配方选项 site-replace,默认为关闭。与 site-id 一起使用。

    新配方选项 site-replace = on 将删除应用程序中名为 site-id 的任何现有对象。将创建一个新的 plone 站点来替换它。

    默认选项设置 site-replace = off 将不会删除应用程序中名为 site-id 的现有对象。 [jeffk]

0.1 (2008-10-11)

  • 使用ZopeSkel [claytron] 创建了配方

下载

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分发

collective.recipe.plonesite-1.12.0.tar.gz (22.9 kB 查看哈希值)

上传时间 源代码

支持者