@@ -224,37 +224,42 @@ services:
224224
225225These variables are used to configure [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS).
226226
227+ (containers-images-backend-add-ons-label)=
227228
228- # ## Add-on variables
229-
230- | Environment variable | Description | Details |
231- | --- | --- | --- |
232- | `ADDONS` | A space separated list of python libraries to install | {ref}`containers-images-backend-add-ons-label` |
233- | `DEVELOP` | A space separated list of python libraries to install in editable mode | {ref}`containers-images-backend-developing-packages-label` |
234- | `PIP_PARAMS` | Parameters used in `pip` installation commands | [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/) |
235-
229+ # ## Add-ons
236230
237- (containers-images-backend- add-ons-label)=
231+ It is possible to include add-ons during startup time in a container created using this image.
238232
239- # ### Add-ons
233+ ` ` ` {warning}
234+ We advise against using this feature on production environments — the recommended method is to
235+ extend the official container images to include your desired add-ons in your own container.
236+ This has several advantages, among which is the certainty that your container will always
237+ run the exact add-on code you built into it.
238+ ` ` `
240239
241- It is possible to install add-ons during startup time in a container created using this image.
242- To do so, pass the `ADDONS` environment variable with a space separated list of requirements to be added to the image :
240+ To do so, pass the `ADDONS` environment variable with a space separated list of requirements to be added to the image
241+ (see below for documentation of the supported variables) :
243242
244243` ` ` shell
245244docker run -p 8080:8080 -e ADDONS="pas.plugins.authomatic" plone/plone-backend:{PLONE_BACKEND_VERSION} start
246245` ` `
247246
247+ After Plone has started, you can add your Plone site (if none exists yet) and install the added
248+ add-ons to your site.
249+
248250This approach also allows you to test Plone with a specific version of one of its core components
249251
250252` ` ` shell
251253docker run -p 8080:8080 -e ADDONS="plone.volto==3.1.0a3" plone/plone-backend:{PLONE_BACKEND_VERSION} start
252254` ` `
253255
254- ` ` ` {warning}
255- We advise against using this feature on production environments.
256- In this case, extend the image as explained before.
257- ` ` `
256+ # ### Add-on variables
257+
258+ | Environment variable | Description | Details |
259+ | --- | --- | --- |
260+ | `ADDONS` | A space separated list of python libraries to install | {ref}`containers-images-backend-add-ons-label` |
261+ | `DEVELOP` | A space separated list of python libraries to install in editable mode | {ref}`containers-images-backend-developing-packages-label` |
262+ | `PIP_PARAMS` | Parameters used in `pip` installation commands | [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/) |
258263
259264# ### Adding configuration to `zope.conf` or additional ZCML
260265
@@ -275,6 +280,11 @@ It is possible to install local packages instead of packages from pip.
275280To do so, pass the `DEVELOP` environment variable with a space separated list of paths to Python packages to be installed.
276281These packages will be installed with `pip install --editable`.
277282
283+ ` ` ` {warning}
284+ We advise against using this feature on production environments — the recommended method is to
285+ extend the official container images to include your desired add-ons in your own container.
286+ ` ` `
287+
278288` ` ` shell
279289docker run -p 8080:8080 -e DEVELOP="/app/src/mysite.policy" plone/plone-backend:{PLONE_BACKEND_VERSION} start
280290` ` `
@@ -285,10 +295,6 @@ This approach also allows you to develop local packages by using a volume.
285295docker run -p 8080:8080 -e DEVELOP="/app/src/mysite.policy" -v /path/to/mysite.policy:/app/src/mysite.policy plone/plone-backend:{PLONE_BACKEND_VERSION} start
286296` ` `
287297
288- ` ` ` {warning}
289- We advise against using this feature on production environments.
290- ` ` `
291-
292298(backend-extending-from-this-image-label)=
293299
294300# # Extending from this image
0 commit comments