Skip to content

Commit 07da0a1

Browse files
committed
Tidy up content.md.
1 parent a7904fa commit 07da0a1

1 file changed

Lines changed: 18 additions & 17 deletions

File tree

plone/content.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ You can enable Plone add-ons via the `ADDONS` environment variable.
5656
$ docker run -p 8080:8080 -e PLONE_ADDONS="eea.facetednavigation Products.PloneFormGen" %%IMAGE%%
5757
```
5858

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 our [documentation](https://5.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).
6060

6161
## Supported environment variables
6262

6363
The Plone image uses several environment variables.
6464

65-
### For basic usage
65+
### Basic usage
6666

6767
- `ADDONS` - Customize Plone via Plone add-ons using this environment variable.
6868
- `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.
@@ -75,24 +75,25 @@ Run Plone and install two add-ons (`eea.facetednavigation` and `collective.easyf
7575
$ docker run -p 8080:8080 -e SITE="mysite" -e ADDONS="eea.facetednavigation collective.easyform" %%IMAGE%%
7676
```
7777

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

8080
```console
8181
-e ADDONS="eea.facetednavigation collective.easyform" \
8282
-e VERSIONS="eea.facetednavigation=13.3 collective.easyform=2.1.0"
8383
```
8484

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

8787
```console
88-
$ docker run -p 8080:8080 -e SITE=plone %%IMAGE%%
89-
90-
$ curl -H 'Accept: application/json' http://localhost:8080/plone
88+
docker run -p 8080:8080 -e SITE=plone %%IMAGE%%
89+
curl -H 'Accept: application/json' http://localhost:8080/plone
9190
```
9291

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

95-
**Plone:**
96+
#### Plone
9697

9798
- `PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using these environment variables.
9899
- `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.
@@ -101,7 +102,7 @@ $ curl -H 'Accept: application/json' http://localhost:8080/plone
101102
- `PLONE_ZCML`, `ZCML` - Include custom Plone add-on ZCML files (formerly `BUILDOUT_ZCML`).
102103
- `PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons (formerly `BUILDOUT_DEVELOP`).
103104

104-
**ZEO:**
105+
#### ZEO
105106

106107
- `ZEO_ADDRESS` - This environment variable allows you to run the Plone image as a ZEO client.
107108
- `ZEO_READ_ONLY` - Run Plone as a read-only ZEO client. Defaults to `off`.
@@ -113,7 +114,7 @@ $ curl -H 'Accept: application/json' http://localhost:8080/plone
113114
- `HEALTH_CHECK_TIMEOUT` - Time in seconds to wait until health check starts. Defaults to `1` second.
114115
- `HEALTH_CHECK_INTERVAL` - Interval in seconds to check that the Zope application is still healthy. Defaults to `1` second.
115116

116-
**CORS:**
117+
#### CORS
117118

118119
- `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`.
119120
- `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`.
@@ -122,16 +123,16 @@ $ curl -H 'Accept: application/json' http://localhost:8080/plone
122123
- `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`.
123124
- `CORS_MAX_AGE` - Indicates how long the results of a preflight request can be cached. Defaults to `3600`.
124125

125-
**RELSTORAGE:**
126+
#### RelStorage
126127

127-
- `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.
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.
128129

129130
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).
130131

131-
- `RELSTORAGE_NAME` - **name** - The name of the storage.
132-
- `RELSTORAGE_READ_ONLY` - **read-only** - If `true`, only reads may be executed against the storage.
133-
- `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).
134-
- `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`.
135136

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

0 commit comments

Comments
 (0)