Skip to main content

Introduction

ftw.publisher.example is a example integration package providing a workflow integration for ftw.publisher. ftw.publisher is a staging and publishing system for Plone contents.

This package is installed on both systems, the editor system (sender) and the public system (receiver) - using the corresponding extras_requires.

It provides the following:

  • A simple custom workflow, registered for the standard content types, providing the default states private, pending, published and revision with the corresponding transitions.

  • Event handlers for the workflow transitions, wich automatically publishes the object on certain transitions.

  • Sanity checks which are configured as conditions for the transitions. They check, if it’s possible to publish the object (e.g. parent is published) and display warnings if referenced objects are not published.

Installing

On the sender system, just add the package to your buildout using the “sender” extras_require. You should also add a cronjob (ClockServer) which invokes the execution of the publisher queue.

You need to create a ClockServer-user on the sender instance with “Manager” role on the plone site. This username / password you need to configure in the sender buildout. The user will then be used to invoke the queue execution using Products.ClockServer.

sender buildout.cfg:

[buildout]
...

[instance1]
...
eggs +=
    ftw.publisher.example[sender]
    Products.ClockServer
zcml +=
    ftw.publisher.example

zope-conf-additional =
    <clock-server>
        method /PLONESITE/@@publisher-config-executeJobs
        period 600
        user SENDER_USER_WITH_MANAGER_ROLE
        password USERS_PASSWORD
    </clock-server>

receiver buildout.cfg:

[buildout]
...

[instance1]
...
eggs +=
    ftw.publisher.example[receiver]
zcml +=
    ftw.publisher.example

Then you need to add a second user on the receiver instance, which will receive the publisher jobs and create / update objects. Therefore he has to have enough priviledges.

Once you have installed the plone-sites, go to the publisher control panel on your sender instance (within the plone control panel) and add the target plone site URL (realm) and the username / password of the user created on the receiver instance.

Credits

Sponsored by 4teamwork GmbH.

Authors:

Changelog

1.0a1

  • Created package initially. [jbaumann]

Release files for ftw.publisher.example 1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ftw.publisher.example 1.0
File Size Uploaded
ftw.publisher.example-1.0.tar.gz 10.1 kB Details

Release files / ftw.publisher.example-1.0.tar.gz

Download URL ftw.publisher.example-1.0.tar.gz
Size 10.1 kB
Tags Source
SHA-256 checksum
How to use checksums
be8a5f778bfbbe73bd24998c809c6bd7a03fd120d7b9364ce0cc874682db71cf
BLAKE2b-256 checksum
How to use checksums
7559fb5919a3527dd13d1ed386873d50579c1b179d1e019ddce46dfa7d022fe6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page