Skip to main content

A buildout recipe to update plone sites

Project description


Upgrade all of your Plone sites quickly!

uncsom.recipe.ploneupdater is a buildout recipe that you can use to update plone sites. It automatizes the following tasks:

  • pack database

  • reinstall products with the quickinstaller or GenericSetup Upgrade Steps

  • run Plone migration (portal_migration.upgrade)

  • clean up invalid GS steps

  • run GS profile

  • install product

uncsom.recipe.ploneupdater will create an updater tool in the buildout bin directory.

This tool can be called with no options to reinstall, upgrade and clean up GS.

It can be called with the –profile option to run all steps from the given profile in GS.

The –pack option will pack the database

If the –pack or –profile options are used, update will not be performed unless the –update option is used. So if you want to pack, apply a profile, and update use the –pack, –profile and –update options together.

Detailed Documentation

Supported options

The recipe supports the following option:


The name of the zope instance admin. The same as defined in the user option of your zope instance. Defaults to ‘admin’

Example usage

We’ll start by creating a buildout that uses the recipe. Let’s create a freash zope instance:

>>> write(sample_buildout, 'buildout.cfg', """
... [buildout]
... parts =
...     instance
...     update-plone
... index =
... find-links =
... eggs =
...     Plone
...     Pillow
... [instance]
... recipe = plone.recipe.zope2instance
... user = admin:admin
... eggs = ${buildout:eggs}
... [update-plone]
... recipe = collective.recipe.updateplone
... admin-user = admin
... """)


  • Ian Anderson (Author)

Change history

0.1 (2013-11-07)

  • Initial Import

1.2 (2013-11-16)

  • Detect instance name

  • Detect zeo or standalone instance

  • Start and stop zeo

  • Stop instance if started

1.2.1 (2013-11-16)

  • Correct options in README

1.3 (2013-11-26)

  • Added ability to run GS profile from the command line

1.3.6 (2013-11-26)

  • returns zeo and zope to same status as when started

1.3.7 (2013-11-26)

  • disabled pack

1.3.8 (2013-11-26)

  • call setSite before running profile

1.5 (2014-04-10)

  • Added new featue to install arbitrary product

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (30.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page