plone on docker
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
4.3 Refs #107, #108 - Fix ADDONS support Oct 30, 2018
5.0 Refs #67 - Release 5.0.8 Jun 13, 2017
5.1 Refs #110 - Release 5.1.5 Jan 29, 2019
docs typo ? Feb 19, 2019
.coafile Docs: some small preps. Nov 17, 2016
.gitignore Update docs Jul 6, 2017
CHANGES.md Release: Update Readme and Changelog Mar 3, 2018
LICENSE.txt Create LICENSE.txt Feb 11, 2016
README.md Refs #110 - Release 5.1.5 Jan 29, 2019

README.md

Plone

Plone is a free and open source content management system built on top of the Zope application server.

Features

  • Images for Plone 5.x and Plone 4.x
  • Enable add-ons via environment variables
  • Choose between Debian or Alpine based images

Supported tags and respective Dockerfile links

Prerequisites

Make sure you have Docker installed and running for your platform. You can download Docker from https://www.docker.com.

Usage

Choose either single Plone instance or ZEO cluster.

It is inadvisable to use following configurations for production.

Standalone Plone Instance

Plone standalone instances are best suited for testing Plone and development.

Download and start the latest Plone 5 container, based on Debian.

$ docker run -p 8080:8080 plone

This image includes EXPOSE 8080 (the Plone port), so standard container linking will make it automatically available to the linked containers. Now you can add a Plone Site at http://localhost:8080 - default Zope user and password are admin/admin.

Plone As ZEO Cluster

ZEO cluster are best suited for production setups, you will need a loadbalancer.

Start ZEO server in the background

$ docker run -d --name=zeo plone zeo

Start 2 Plone clients (also in the background)

$ docker run -d --name=instance1 --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8081:8080 plone
$ docker run -d --name=instance2 --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8082:8080 plone

Start Plone In Debug Mode

You can also start Plone in debug mode (fg) by running

$ docker run -p 8080:8080 plone fg

Debug mode may also be used with ZEO

$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8080:8080 plone fg

For more information on how to extend this image with your own custom settings, adding more add-ons, building it or mounting volumes, please refer to our documentation.

Supported Environment Variables

The Plone image uses several environment variable that allow to specify a more specific setup.

For Basic Usage

  • ADDONS - Customize Plone via Plone add-ons using this environment variable
  • ZEO_ADDRESS - This environment variable allows you to run Plone image as a ZEO client.

Run Plone with ZEO and install two addons (PloneFormGen and collective.roster)

$ docker run --name=instance1 --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8080:8080 \
-e ADDONS="Products.PloneFormGen collective.roster" plone

To use specific add-ons versions:

 -e ADDONS="Products.PloneFormGen==1.8.5 collective.roster==2.3.1"

For Advanced Usage

  • PLONE_ZCML, ZCML - Include custom Plone add-ons ZCML files (former BUILDOUT_ZCML)
  • PLONE_DEVELOP, DEVELOP - Develop new or existing Plone add-ons (former BUILDOUT_DEVELOP)
  • ZEO_READ_ONLY - Run Plone as a read-only ZEO client. Defaults to off.
  • ZEO_CLIENT_READ_ONLY_FALLBACK - A flag indicating whether a read-only remote storage should be acceptable as a fallback when no writable storages are available. Defaults to false.
  • ZEO_SHARED_BLOB_DIR - Set this to on if the ZEO server and the instance have access to the same directory. Defaults to off.
  • ZEO_STORAGE - Set the storage number of the ZEO storage. Defaults to 1.
  • ZEO_CLIENT_CACHE_SIZE - Set the size of the ZEO client cache. Defaults to 128MB.
  • ZEO_PACK_KEEP_OLD - Can be set to false to disable the creation of *.fs.old files before the pack is run. Defaults to true.
  • HEALTH_CHECK_TIMEOUT - Time in seconds to wait until health check starts. Defaults to 1 second.
  • HEALTH_CHECK_INTERVAL - Interval in seconds to check that the Zope application is still healthy. Defaults to 1 second.

Documentation

Full documentation for end users can be found online at docs.plone.org.

Contribute

Support

If you are having issues, please let us know at https://community.plone.org

License

The project is licensed under the GPLv2.