Skip to content

Commit 1bfbd65

Browse files
avoineaavoinea
authored
Plone: Add deprecation notice with info about Plone 6 Docker images (#2479)
1 parent c28d0b5 commit 1bfbd65

File tree

3 files changed

+82
-69
lines changed

3 files changed

+82
-69
lines changed

‎plone/README-short.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Plone is a free and open source content management system built on top of Zope.
1+
DEPRECATED. Plone is a free and open source content management system built on top of Zope.

‎plone/content.md

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -6,136 +6,136 @@
66

77
## Features
88

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

1514
## Usage
1615

1716
### Start a single Plone instance
1817

1918
This will download and start the latest Plone 5 container, based on [Debian](https://www.debian.org/).
2019

21-
```console
22-
$ docker run -p 8080:8080 %%IMAGE%%
20+
```shell
21+
docker run -p 8080:8080 %%IMAGE%%
2322
```
2423

25-
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`.
24+
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`.
2625

2726
### Start Plone within a ZEO cluster
2827

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

31-
Start ZEO server in the background
30+
Start ZEO server in the background.
3231

33-
```console
34-
$ docker run --name=zeo %%IMAGE%% zeo
32+
```shell
33+
docker run --name=zeo %%IMAGE%% zeo
3534
```
3635

37-
Start 2 Plone clients (also in the background)
36+
Start two Plone clients, also in the background.
3837

39-
```console
40-
$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8081:8080 %%IMAGE%%
41-
$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8082:8080 %%IMAGE%%
38+
```shell
39+
docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8081:8080 %%IMAGE%%
40+
docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8082:8080 %%IMAGE%%
4241
```
4342

4443
### Start Plone in debug mode
4544

46-
You can also start Plone in debug mode (`fg`) by running
45+
You can also start Plone in debug mode (`fg`) by running the following command.
4746

48-
```console
49-
$ docker run -p 8080:8080 %%IMAGE%% fg
47+
```shell
48+
docker run -p 8080:8080 %%IMAGE%% fg
5049
```
5150

5251
### Add-ons
5352

54-
You can enable Plone add-ons via the `ADDONS` environment variable
53+
You can enable Plone add-ons via the `ADDONS` environment variable.
5554

56-
```console
57-
$ docker run -p 8080:8080 -e PLONE_ADDONS="eea.facetednavigation Products.PloneFormGen" %%IMAGE%%
55+
```shell
56+
docker run -p 8080:8080 -e PLONE_ADDONS="eea.facetednavigation Products.PloneFormGen" %%IMAGE%%
5857
```
5958

60-
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)
59+
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 the [Plone 5 documentation](https://5.docs.plone.org/manage/docker/docs/index.html).
6160

62-
## Supported Environment Variables
61+
## Supported environment variables
6362

64-
The Plone image uses several environment variable that allow to specify a more specific setup.
63+
The Plone image uses several environment variables.
6564

66-
### For Basic Usage
65+
### Basic usage
6766

68-
- `ADDONS` - Customize Plone via Plone add-ons using this environment variable
69-
- `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
70-
- `ZEO_ADDRESS` - This environment variable allows you to run Plone image as a ZEO client.
71-
- `VERSIONS` - Use specific versions of Plone Add-on or python libraries
67+
- `ADDONS` - Customize Plone via Plone add-ons using this environment variable.
68+
- `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.
69+
- `ZEO_ADDRESS` - This environment variable allows you to run the Plone image as a ZEO client.
70+
- `VERSIONS` - Use specific versions of Plone add-on or Python libraries.
7271

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

75-
```console
76-
$ docker run -p 8080:8080 -e SITE="mysite" -e ADDONS="eea.facetednavigation collective.easyform" %%IMAGE%%
74+
```shell
75+
docker run -p 8080:8080 -e SITE="mysite" -e ADDONS="eea.facetednavigation collective.easyform" %%IMAGE%%
7776
```
7877

79-
To use specific add-ons versions:
78+
To use specific add-on versions, change the environment variable arguments as shown.
8079

81-
```console
82-
-e ADDONS="eea.facetednavigation collective.easyform" \
83-
-e VERSIONS="eea.facetednavigation=13.3 collective.easyform=2.1.0"
80+
```shell
81+
-e ADDONS="eea.facetednavigation collective.easyform" \
82+
-e VERSIONS="eea.facetednavigation=13.3 collective.easyform=2.1.0"
8483
```
8584

86-
RestAPI:
85+
To use Plone REST API, start the Plone Docker image, then issue a command to `curl`.
8786

88-
```console
89-
$ docker run -p 8080:8080 -e SITE=plone %%IMAGE%%
90-
91-
$ curl -H 'Accept: application/json' http://localhost:8080/plone
87+
```shell
88+
docker run -p 8080:8080 -e SITE=plone %%IMAGE%%
89+
curl -H 'Accept: application/json' http://localhost:8080/plone
9290
```
9391

94-
### For Advanced Usage
92+
### Advanced usage
93+
94+
For advanced usage, the images support the following environment variables.
9595

96-
**Plone:**
96+
#### Plone
9797

98-
- `PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using this environment variable
99-
- `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
100-
- `PLONE_VERSIONS`, `VERSIONS` - Use specific versions of Plone Add-on or python libraries
101-
- `PLONE_PROFILES, PROFILES` - GenericSetup profiles to include when `SITE` environment provided.
102-
- `PLONE_ZCML`, `ZCML` - Include custom Plone add-ons ZCML files (former `BUILDOUT_ZCML`)
103-
- `PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons (former `BUILDOUT_DEVELOP`)
98+
- `PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using these environment variables.
99+
- `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.
100+
- `PLONE_VERSIONS`, `VERSIONS` - Use specific versions of Plone add-on or Python libraries.
101+
- `PLONE_PROFILES, PROFILES` - GenericSetup profiles to include when the `SITE` environment is provided.
102+
- `PLONE_ZCML`, `ZCML` - Include custom Plone add-on ZCML files (formerly `BUILDOUT_ZCML`).
103+
- `PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons (formerly `BUILDOUT_DEVELOP`).
104104

105-
**ZEO:**
105+
#### ZEO
106106

107-
- `ZEO_ADDRESS` - This environment variable allows you to run Plone image as a ZEO client.
107+
- `ZEO_ADDRESS` - This environment variable allows you to run the Plone image as a ZEO client.
108108
- `ZEO_READ_ONLY` - Run Plone as a read-only ZEO client. Defaults to `off`.
109109
- `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`.
110-
- `ZEO_SHARED_BLOB_DIR` - Set this to on if the ZEO server and the instance have access to the same directory. Defaults to `off`.
110+
- `ZEO_SHARED_BLOB_DIR` - Set this to `on` if the ZEO server and the instance have access to the same directory. Defaults to `off`.
111111
- `ZEO_STORAGE` - Set the storage number of the ZEO storage. Defaults to `1`.
112112
- `ZEO_CLIENT_CACHE_SIZE` - Set the size of the ZEO client cache. Defaults to `128MB`.
113-
- `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.
113+
- `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`.
114114
- `HEALTH_CHECK_TIMEOUT` - Time in seconds to wait until health check starts. Defaults to `1` second.
115115
- `HEALTH_CHECK_INTERVAL` - Interval in seconds to check that the Zope application is still healthy. Defaults to `1` second.
116116

117-
**CORS:**
117+
#### CORS
118118

119-
- `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`
120-
- `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`
121-
- `CORS_ALLOW_CREDENTIALS` - Indicates whether the resource supports user credentials in the request. Defaults to `true`
122-
- `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`
123-
- `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`
124-
- `CORS_MAX_AGE` - Indicates how long the results of a preflight request can be cached. Defaults to `3600`
119+
- `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`.
120+
- `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`.
121+
- `CORS_ALLOW_CREDENTIALS` - Indicates whether the resource supports user credentials in the request. Defaults to `true`.
122+
- `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`.
123+
- `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`.
124+
- `CORS_MAX_AGE` - Indicates how long the results of a preflight request can be cached. Defaults to `3600`.
125125

126-
**RELSTORAGE:**
126+
#### RelStorage
127127

128-
- `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.
128+
- `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.
129129

130130
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).
131131

132-
- `RELSTORAGE_NAME` - **name** - The name of the storage.
133-
- `RELSTORAGE_READ_ONLY` - **read-only** - If true, only reads may be executed against the storage.
134-
- `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).
135-
- `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`
132+
- `RELSTORAGE_NAME` - `name` - The name of the storage.
133+
- `RELSTORAGE_READ_ONLY` - `read-only` - If `true`, only reads may be executed against the storage.
134+
- `RELSTORAGE_KEEP_HISTORY` - `keep-history` - If this option is set to `true`, the default value, then the adapter will create and use a history-preserving database schema, such as FileStorage.
135+
- `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 doesn't exist. If no value, or an empty value, is provided, then no BLOB support will be provided. Defaults to `/plone/instance/var/blobstorage`.
136136

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

139139
## Documentation
140140

141-
Full documentation for end users can be found online at [docs.plone.org](https://docs.plone.org/manage/docker/docs/usage/index.html)
141+
Full documentation for end users can be found at [5.docs.plone.org](https://5.docs.plone.org/manage/docker/docs/index.html).

‎plone/deprecated.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ⚠️ DEPRECATION NOTICE ⚠️
2+
3+
- Plone 4.x is no longer supported.
4+
- Plone 5.x is no longer supported.
5+
- It is strongly recommended to migrate to the latest available Plone version. See https://plone.org/download/release-schedule for details.
6+
7+
Beginning with Plone 6.x, the frontend and backend run in separate Docker images. There's also a a ZEO server Docker image. All Plone 6.0 and later images are supported by the Plone Foundation and are maintained by community volunteers.
8+
9+
- [Plone Backend](https://github.com/plone/plone-backend)
10+
- [Plone Frontend](https://github.com/plone/plone-frontend)
11+
- [ZEO Server](https://github.com/plone/plone-zeo/)
12+
13+
For Docker image usage, see [Plone 6 Documentation](https://6.docs.plone.org/install/containers/images/index.html).

0 commit comments

Comments
 (0)