Skip to content

Plone: Add info about Plone 6 Docker images #2479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tianon merged 24 commits into from
Aug 27, 2025
Merged

Plone: Add info about Plone 6 Docker images #2479

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
5ad3b3d
Add info about Plone 6 Docker images
avoinea Jul 31, 2024
4ea296c
Update plone/content.md
avoinea Aug 1, 2024
10063ca
Update plone/content.md
avoinea Aug 1, 2024
52e9727
Add deprecated.md and fix documentation links
avoinea Aug 1, 2024
6af77d9
Update content.md
stevepiercy Aug 3, 2024
864b9c6
Fix spacing
stevepiercy Aug 3, 2024
66fdf9f
Add warning about support and what to do
stevepiercy Aug 3, 2024
f9d7526
Move Versions into deprecation notice, and merge.
stevepiercy Aug 3, 2024
0069420
Comply with markdownfmt.sh. Using tabs instead of spaces is silly.
stevepiercy Aug 5, 2024
1e4c0a4
Tidy up remaining markup
stevepiercy Aug 6, 2024
dfd9be6
Merge branch 'docker-library:master' into master
avoinea May 28, 2025
aae5cfc
Update plone/deprecated.md
avoinea Jun 5, 2025
5805a62
Add deprecated notice.
stevepiercy Aug 19, 2025
7f0dff4
Add link to documentation for Docker image usage, add ZEO image, twea…
stevepiercy Aug 19, 2025
cbe8446
Curse the Markdown enforcement goon!
stevepiercy Aug 19, 2025
a7904fa
Revise deprecated.md, moving what is actually supported and maintaine…
stevepiercy Aug 19, 2025
07da0a1
Tidy up content.md.
stevepiercy Aug 19, 2025
b1669a0
Add supported versions section with link to deprecation notice
stevepiercy Aug 19, 2025
db757d8
Tabs not spaces, grrr, the goon strikes again.
stevepiercy Aug 19, 2025
e4d1c6e
Remove redundant Supported versions section and deprecation reference
stevepiercy Aug 22, 2025
3abd58f
Replace console with generic shell language.
stevepiercy Aug 22, 2025
c1ccceb
Clarify deprecated language and use explicit link instead of vague "h…
stevepiercy Aug 22, 2025
d3f9221
Update plone/deprecated.md
stevepiercy Aug 27, 2025
b71f5b7
Restore missing line break for paragraph, not list continuation.
stevepiercy Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 40 additions & 41 deletions plone/content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@

## Features

- Images for Plone 5.x and Plone 4.x
- Enable add-ons via environment variables
- Enable add-ons via environment variables.
- Choose between [Debian](https://www.debian.org/) or [Alpine](http://www.alpinelinux.org/) based images.
- Built-in RelStorage support, configurable via environment variables (requires Plone 5.2.4+)
- Built-in LDAP/AD support via pas.plugins.ldap (requires Plone 5.2.4+)
- Built-in RelStorage support, configurable via environment variables (requires Plone 5.2.4+).
- Built-in LDAP/AD support via `pas.plugins.ldap` (requires Plone 5.2.4+).

## Usage

Expand All @@ -22,19 +21,19 @@ This will download and start the latest Plone 5 container, based on [Debian](htt
$ docker run -p 8080:8080 %%IMAGE%%
```

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`.
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. The default Zope user and password are `admin/admin`.

### Start Plone within a ZEO cluster

ZEO cluster are best suited for production setups, you will **need** a loadbalancer.
A ZEO cluster is best suited for production setups. You will **need** a load balancer.

Start ZEO server in the background
Start ZEO server in the background.

```console
$ docker run --name=zeo %%IMAGE%% zeo
```

Start 2 Plone clients (also in the background)
Start two Plone clients, also in the background.

```console
$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8081:8080 %%IMAGE%%
Expand All @@ -43,40 +42,40 @@ $ docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8082:8080 %%IMAGE%%

### Start Plone in debug mode

You can also start Plone in debug mode (`fg`) by running
You can also start Plone in debug mode (`fg`) by running the following command.

```console
$ docker run -p 8080:8080 %%IMAGE%% fg
```

### Add-ons

You can enable Plone add-ons via the `ADDONS` environment variable
You can enable Plone add-ons via the `ADDONS` environment variable.

```console
$ docker run -p 8080:8080 -e PLONE_ADDONS="eea.facetednavigation Products.PloneFormGen" %%IMAGE%%
```

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](https://docs.plone.org/manage/docker/docs/index.html)
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](https://5.docs.plone.org/manage/docker/docs/index.html).

## Supported Environment Variables
## Supported environment variables

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

### For Basic Usage
### For basic usage

- `ADDONS` - Customize Plone via Plone add-ons using this environment variable
- `SITE` - Add Plone instance with this id to `Data.fs` on first run. If NOT provided, you'll have to manually add a Plone Site via web UI
- `ZEO_ADDRESS` - This environment variable allows you to run Plone image as a ZEO client.
- `VERSIONS` - Use specific versions of Plone Add-on or python libraries
- `ADDONS` - Customize Plone via Plone add-ons using this environment variable.
- `SITE` - Add a Plone instance with this ID to `Data.fs` on first run. If *not* provided, you'll have to manually add a Plone site via the web UI.
- `ZEO_ADDRESS` - This environment variable allows you to run the Plone image as a ZEO client.
- `VERSIONS` - Use specific versions of Plone add-on or Python libraries.

Run Plone and install two addons (eea.facetednavigation and collective.easyform)
Run Plone and install two add-ons (`eea.facetednavigation` and `collective.easyform`).

```console
$ docker run -p 8080:8080 -e SITE="mysite" -e ADDONS="eea.facetednavigation collective.easyform" %%IMAGE%%
```

To use specific add-ons versions:
To use specific add-on versions:

```console
-e ADDONS="eea.facetednavigation collective.easyform" \
Expand All @@ -95,47 +94,47 @@ $ curl -H 'Accept: application/json' http://localhost:8080/plone

**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 (former `BUILDOUT_ZCML`)
- `PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons (former `BUILDOUT_DEVELOP`)
- `PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using these environment variables.
- `PLONE_SITE`, `SITE` - Add a Plone instance with this ID to `Data.fs` on first run. If *not* provided, you'll have to manually add a Plone site via the web UI.
- `PLONE_VERSIONS`, `VERSIONS` - Use specific versions of Plone add-on or Python libraries.
- `PLONE_PROFILES, PROFILES` - GenericSetup profiles to include when the `SITE` environment is provided.
- `PLONE_ZCML`, `ZCML` - Include custom Plone add-on ZCML files (formerly `BUILDOUT_ZCML`).
- `PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons (formerly `BUILDOUT_DEVELOP`).

**ZEO:**

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

**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`
- `CORS_ALLOW_ORIGIN` - Origins that are allowed access to the resource. Either a comma separated list of origins, for example, `https://example.net,https://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, for example, `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, for example, `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, for example, `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`.

**RELSTORAGE:**

- `RELSTORAGE_ADAPTER_OPTIONS` - A comma separated list of RelStorage adapter options to set for the plone instance (using [plone.recipe.zope2instance](https://relstorage.readthedocs.io/en/latest/configure-application.html#configuring-plone)). This is required in order to use RelStorage.
- `RELSTORAGE_ADAPTER_OPTIONS` - A comma separated list of RelStorage adapter options to set for the plone instance, using [`plone.recipe.zope2instance`](https://relstorage.readthedocs.io/en/latest/configure-application.html#configuring-plone). This is required to use RelStorage.

All other available environment variables match exactly with RelStorage settings, according to the [settings specification available on the docs](https://relstorage.readthedocs.io/en/latest/relstorage-options.html).

- `RELSTORAGE_NAME` - **name** - The name of the storage.
- `RELSTORAGE_READ_ONLY` - **read-only** - If true, only reads may be executed against the storage.
- `RELSTORAGE_KEEP_HISTORY` - **keep-history** - If this option is set to true (the default), the adapter will create and use a history-preserving database schema (like FileStorage).
- `RELSTORAGE_BLOB_DIR` - **blob-dir** - If supplied, the storage will provide ZODB blob support; this option specifies the name of the directory to hold blob data. The directory will be created if it does not exist. If no value (or an empty value) is provided, then no blob support will be provided. Default: `/plone/instance/var/blobstorage`
- `RELSTORAGE_READ_ONLY` - **read-only** - If `true`, only reads may be executed against the storage.
- `RELSTORAGE_KEEP_HISTORY` - **keep-history** - If this option is set to `true` (the default), the adapter will create and use a history-preserving database schema (like FileStorage).
- `RELSTORAGE_BLOB_DIR` - **blob-dir** - If supplied, the storage will provide ZODB blob support. This option specifies the name of the directory to hold blob data. The directory will be created if it does not exist. If no value, or an empty value, is provided, then no blob support will be provided. Default: `/plone/instance/var/blobstorage`.

[See more](https://relstorage.readthedocs.io/en/latest/relstorage-options.html)
[See more RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html).

## Documentation

Full documentation for end users can be found online at [docs.plone.org](https://docs.plone.org/manage/docker/docs/usage/index.html)
Full documentation for end users can be found at [5.docs.plone.org](https://5.docs.plone.org/manage/docker/docs/index.html).
12 changes: 12 additions & 0 deletions plone/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ⚠️ DEPRECATION NOTICE ⚠️

- Plone 4.x is no longer supported.
- Plone 5.x is out of maintenance support, and will exit security support on 2024-10-31.
- It is strongly recommended to migrate to the latest available Plone version. See https://plone.org/download/release-schedule for details.

The official Docker images for Plone 5.x and Plone 4.x are available here, and are maintained by community volunteers.
Copy link
Member

@tianon tianon Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be present tense, or past tense? (I don't think they're being actively maintained right now, are they?)

We should also add a DEPRECATED; prefix to README-short.txt (as seen in #2583).

Copy link
Member

@tianon tianon Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To add a little more detail for #2583, my goal there was to make it really clear (immediately) to users on the page that any images they find here are old, outdated, and unsupported, and they should look elsewhere ASAP - I think this description gets there, but it's not quite as immediately obvious.

I don't have a strong preference either way, as long as we make it clear that this repository is officially deprecated and unsupported (and I think the tense here is the only blocking issue I have with that).

Copy link

@stevepiercy stevepiercy Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tianon I lack permission to make a comment on your PR #2583, so here it is:

plone/deprecated.md is not listed as one of those in docker-library/docs. Is it used or ignored? See https://github.com/docker-library/docs?tab=readme-ov-file#files-related-to-an-images-docs.

I'm revising this PR to incorporate your suggestions, once we verify that question.

Copy link

@stevepiercy stevepiercy Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few revisions. Hopefully this file gets included in the repo.

Copy link

@stevepiercy stevepiercy Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I verified that this file gets prepended to the top of the automatically generated README.md. You can test by running ./update.sh plone from the root of the repo.

@tianon @avoinea @fredvd would you please take another look? Thank you!

Copy link
Contributor Author

@avoinea avoinea Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.


Beginning with Plone 6.x, the frontend and backend run in separate Docker images, and are supported by the Plone Foundation.

- [Plone Backend](https://github.com/plone/plone-backend)
- [Plone Frontend](https://github.com/plone/plone-frontend)