From 5ad3b3defafbcb1e0921fdc98ae68c63faf5ab1a Mon Sep 17 00:00:00 2001 From: alin Date: Wed, 31 Jul 2024 16:57:40 +0300 Subject: [PATCH 01/10] Add info about Plone 6 Docker images --- plone/content.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/plone/content.md b/plone/content.md index 730d861443bb..d1f493e5390a 100644 --- a/plone/content.md +++ b/plone/content.md @@ -6,7 +6,8 @@ ## Features -- Images for Plone 5.x and Plone 4.x +- Images for **Plone 5.x** and **Plone 4.x** +- Images for **Plone 6.x** are available at [plone/plone-backend](https://hub.docker.com/r/plone/plone-backend) and [plone/plone-frontend](https://hub.docker.com/r/plone/plone-frontend) - 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+) From 4ea296c9efa245ece3df90c1d36436f6e7cdb961 Mon Sep 17 00:00:00 2001 From: Alin Voinea Date: Thu, 1 Aug 2024 08:56:43 +0300 Subject: [PATCH 02/10] Update plone/content.md Co-authored-by: Steve Piercy --- plone/content.md | 1 - 1 file changed, 1 deletion(-) diff --git a/plone/content.md b/plone/content.md index d1f493e5390a..53d8e7091824 100644 --- a/plone/content.md +++ b/plone/content.md @@ -6,7 +6,6 @@ ## Features -- Images for **Plone 5.x** and **Plone 4.x** - Images for **Plone 6.x** are available at [plone/plone-backend](https://hub.docker.com/r/plone/plone-backend) and [plone/plone-frontend](https://hub.docker.com/r/plone/plone-frontend) - Enable add-ons via environment variables - Choose between [Debian](https://www.debian.org/) or [Alpine](http://www.alpinelinux.org/) based images. From 10063ca3a8b6ef350b9dab8f35ec6b409007bcf3 Mon Sep 17 00:00:00 2001 From: Alin Voinea Date: Thu, 1 Aug 2024 08:57:03 +0300 Subject: [PATCH 03/10] Update plone/content.md Co-authored-by: Steve Piercy --- plone/content.md | 1 - 1 file changed, 1 deletion(-) diff --git a/plone/content.md b/plone/content.md index 53d8e7091824..31158594a2f2 100644 --- a/plone/content.md +++ b/plone/content.md @@ -6,7 +6,6 @@ ## Features -- Images for **Plone 6.x** are available at [plone/plone-backend](https://hub.docker.com/r/plone/plone-backend) and [plone/plone-frontend](https://hub.docker.com/r/plone/plone-frontend) - 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+) From 52e9727e6f647d6ab104f15cb575a5871e1d7104 Mon Sep 17 00:00:00 2001 From: alin Date: Thu, 1 Aug 2024 09:16:24 +0300 Subject: [PATCH 04/10] Add deprecated.md and fix documentation links --- plone/content.md | 4 ++-- plone/deprecated.md | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 plone/deprecated.md diff --git a/plone/content.md b/plone/content.md index 31158594a2f2..598948f79cc0 100644 --- a/plone/content.md +++ b/plone/content.md @@ -56,7 +56,7 @@ You can enable Plone add-ons via the `ADDONS` environment variable $ 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 @@ -137,4 +137,4 @@ All other available environment variables match exactly with RelStorage settings ## 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 online at [5.docs.plone.org](https://5.docs.plone.org/manage/docker/docs/index.html) diff --git a/plone/deprecated.md b/plone/deprecated.md new file mode 100644 index 000000000000..39c6306669bc --- /dev/null +++ b/plone/deprecated.md @@ -0,0 +1,3 @@ +# IMPORTANT NOTE + +⚠️⚠️⚠️ This image is maintained by community volunteers. For the latest Plone releases, use the [Plone Backend](https://github.com/plone/plone-backend) and [Plone Frontend](https://github.com/plone/plone-frontend) images maintained by the Plone Foundation. From 6af77d9e8ae8d1a78a6ce02e8b8e47db17ea83c5 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 3 Aug 2024 14:50:11 -0700 Subject: [PATCH 05/10] Update content.md This is my review. In addition to the new section with versions, I overhauled the docs to comply with Plone 6 Documentation guidelines, mostly. --- plone/content.md | 105 +++++++++++++++++++++++++---------------------- 1 file changed, 57 insertions(+), 48 deletions(-) diff --git a/plone/content.md b/plone/content.md index 598948f79cc0..6004eaf4b426 100644 --- a/plone/content.md +++ b/plone/content.md @@ -4,12 +4,21 @@ %%LOGO%% +## Versions + +The official Docker images for Plone 5.x and Plone 4.x are available here. + +Beginning with Plone 6.x, the frontend and backend run in separate Docker images. + +- [Plone Backend](https://github.com/plone/plone-backend) +- [Plone Frontend](https://github.com/plone/plone-frontend) + ## Features -- 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+) +- 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+). ## Usage @@ -21,19 +30,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%% @@ -42,7 +51,7 @@ $ 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 @@ -50,32 +59,32 @@ $ 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://5.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" \ @@ -94,47 +103,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_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. +- `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_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. **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_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`. - [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 [5.docs.plone.org](https://5.docs.plone.org/manage/docker/docs/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). From 864b9c6f889f196c311fc76734521f7069d9a5d8 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 3 Aug 2024 14:51:17 -0700 Subject: [PATCH 06/10] Fix spacing --- plone/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plone/content.md b/plone/content.md index 6004eaf4b426..20c4960df4b8 100644 --- a/plone/content.md +++ b/plone/content.md @@ -142,7 +142,7 @@ All other available environment variables match exactly with RelStorage settings - `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 RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html). + [See more RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html). ## Documentation From 66fdf9fb3cbf444b2a7ff1e8d82160d76a3d483d Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 3 Aug 2024 14:56:09 -0700 Subject: [PATCH 07/10] Add warning about support and what to do --- plone/content.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/plone/content.md b/plone/content.md index 20c4960df4b8..b6c12a7d868e 100644 --- a/plone/content.md +++ b/plone/content.md @@ -8,6 +8,12 @@ The official Docker images for Plone 5.x and Plone 4.x are available here. +**IMPORTANT** + +- 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. + Beginning with Plone 6.x, the frontend and backend run in separate Docker images. - [Plone Backend](https://github.com/plone/plone-backend) From f9d7526027415f5ddf2175ae2ac5b0b4e97a9553 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 3 Aug 2024 15:07:05 -0700 Subject: [PATCH 08/10] Move Versions into deprecation notice, and merge. --- plone/content.md | 15 --------------- plone/deprecated.md | 13 +++++++++++-- 2 files changed, 11 insertions(+), 17 deletions(-) diff --git a/plone/content.md b/plone/content.md index b6c12a7d868e..caaab53234df 100644 --- a/plone/content.md +++ b/plone/content.md @@ -4,21 +4,6 @@ %%LOGO%% -## Versions - -The official Docker images for Plone 5.x and Plone 4.x are available here. - -**IMPORTANT** - -- 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. - -Beginning with Plone 6.x, the frontend and backend run in separate Docker images. - -- [Plone Backend](https://github.com/plone/plone-backend) -- [Plone Frontend](https://github.com/plone/plone-frontend) - ## Features - Enable add-ons via environment variables. diff --git a/plone/deprecated.md b/plone/deprecated.md index 39c6306669bc..060a0026e765 100644 --- a/plone/deprecated.md +++ b/plone/deprecated.md @@ -1,3 +1,12 @@ -# IMPORTANT NOTE +# ⚠️ DEPRECATION NOTICE ⚠️ -⚠️⚠️⚠️ This image is maintained by community volunteers. For the latest Plone releases, use the [Plone Backend](https://github.com/plone/plone-backend) and [Plone Frontend](https://github.com/plone/plone-frontend) images maintained by the Plone Foundation. +- 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. + +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) From 00694208b3e4685949404571829039d97393356a Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 5 Aug 2024 15:47:03 -0700 Subject: [PATCH 09/10] Comply with markdownfmt.sh. Using tabs instead of spaces is silly. --- plone/content.md | 70 ++++++++++++++++++++++----------------------- plone/deprecated.md | 10 +++---- 2 files changed, 40 insertions(+), 40 deletions(-) diff --git a/plone/content.md b/plone/content.md index caaab53234df..9b32f2697a71 100644 --- a/plone/content.md +++ b/plone/content.md @@ -6,10 +6,10 @@ ## Features -- 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+). +- 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+). ## Usage @@ -64,10 +64,10 @@ The Plone image uses several environment variables. ### For basic usage -- `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. +- `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 add-ons (`eea.facetednavigation` and `collective.easyform`). @@ -94,46 +94,46 @@ $ curl -H 'Accept: application/json' http://localhost:8080/plone **Plone:** -- `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`). +- `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 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_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. +- `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_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. **CORS:** -- `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`. +- `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 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_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`. - [See more RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html). + [See more RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html). ## Documentation diff --git a/plone/deprecated.md b/plone/deprecated.md index 060a0026e765..97418b7f1765 100644 --- a/plone/deprecated.md +++ b/plone/deprecated.md @@ -1,12 +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. +- 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. 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) +- [Plone Backend](https://github.com/plone/plone-backend) +- [Plone Frontend](https://github.com/plone/plone-frontend) From 1e4c0a4739816acd85062f638d59831f2b6d85a9 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 5 Aug 2024 19:19:06 -0700 Subject: [PATCH 10/10] Tidy up remaining markup --- plone/content.md | 6 +++--- plone/deprecated.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/plone/content.md b/plone/content.md index 9b32f2697a71..341d47f6d345 100644 --- a/plone/content.md +++ b/plone/content.md @@ -65,7 +65,7 @@ The Plone image uses several environment variables. ### For basic usage - `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. +- `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. @@ -95,7 +95,7 @@ $ curl -H 'Accept: application/json' http://localhost:8080/plone **Plone:** - `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_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`). @@ -133,7 +133,7 @@ All other available environment variables match exactly with RelStorage settings - `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 RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html). + [See more RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html). ## Documentation diff --git a/plone/deprecated.md b/plone/deprecated.md index 97418b7f1765..0b7cd9b23038 100644 --- a/plone/deprecated.md +++ b/plone/deprecated.md @@ -1,4 +1,4 @@ -# ⚠️ DEPRECATION NOTICE ⚠️ +# ⚠️ 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.