Code Monkey home page Code Monkey logo

plone.docker's Introduction

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

NOTE: Python 2 based Docker images are no longer supported by the Docker Official Images, thus you'll have to use plone/plone:5-python2 instead of plone:5-python2

Choose either single Plone instance or ZEO cluster.

NOTE: 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.

By using the tags listed above a Plone container with a different version can be downloaded and started.

The following command starts a Plone 4.3 container, based on Alpine.

$ docker run -p 8080:8080 plone:4.3-alpine

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.
  • SITE - Add Plone with this id to Data.fs on first run. If NOT provided, you'll have to manually add a Plone Site via web UI
  • VERSIONS - Use specific versions of Plone Add-on or python libraries

Run Plone and install two addons (eea.facetednavigation and collective.easyform)

$ docker run -p 8080:8080 -e SITE="mysite" -e ADDONS="eea.facetednavigation collective.easyform" plone

To use specific add-ons versions:

 -e ADDONS="eea.facetednavigation collective.easyform" -e VERSIONS="eea.facetednavigation=13.3 collective.easyform=2.1.0"

RestAPI:

$ docker run -p 8080:8080 -e SITE=plone plone

$ curl -H 'Accept: application/json' http://localhost:8080/plone

For Advanced Usage

Plone:

  • PLONE_ADDONS, ADDONS - Customize Plone via Plone add-ons using this environment variable
  • PLONE_SITE, SITE - Add Plone with this id to Data.fs on first run. If NOT provided, you'll have to manually add a Plone Site via web UI
  • PLONE_VERSIONS, VERSIONS - Use specific versions of Plone Add-on or python libraries
  • PLONE_PROFILES, PROFILES - GenericSetup profiles to include when SITE environment provided.
  • PLONE_ZCML, ZCML - Include custom Plone add-ons ZCML files
  • PLONE_DEVELOP, DEVELOP - Develop new or existing Plone add-ons

ZEO:

  • ZEO_ADDRESS - This environment variable allows you to run Plone image as a ZEO client.
  • 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.

CORS:

  • CORS_ALLOW_ORIGIN - Origins that are allowed access to the resource. Either a comma separated list of origins, e.g. http://example.net,http://mydomain.com or *. Defaults to http://localhost:3000,http://127.0.0.1:3000
  • CORS_ALLOW_METHODS - A comma separated list of HTTP method names that are allowed by this CORS policy, e.g. DELETE,GET,OPTIONS,PATCH,POST,PUT. Defaults to DELETE,GET,OPTIONS,PATCH,POST,PUT
  • CORS_ALLOW_CREDENTIALS - Indicates whether the resource supports user credentials in the request. Defaults to true
  • CORS_EXPOSE_HEADERS - A comma separated list of response headers clients can access, e.g. Content-Length,X-My-Header. Defaults to Content-Length,X-My-Header
  • CORS_ALLOW_HEADERS - A comma separated list of request headers allowed to be sent by the client, e.g. X-My-Header. Defaults to Accept,Authorization,Content-Type,X-Custom-Header
  • CORS_MAX_AGE - Indicates how long the results of a preflight request can be cached. Defaults to 3600

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.

plone.docker's People

Contributors

avoinea avatar jladage avatar ju55i avatar pnicolli avatar demarant avatar pigeonflight avatar bloodbare avatar staeff avatar tkimnguyen avatar tianon avatar gforcada avatar gotcha avatar mrtango avatar odidev avatar rigarash avatar stefanfoulis avatar daggelpop avatar svx avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.