You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: plone/content.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,13 +56,13 @@ You can enable Plone add-ons via the `ADDONS` environment variable.
56
56
$ docker run -p 8080:8080 -e PLONE_ADDONS="eea.facetednavigation Products.PloneFormGen" %%IMAGE%%
57
57
```
58
58
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).
60
60
61
61
## Supported environment variables
62
62
63
63
The Plone image uses several environment variables.
64
64
65
-
### For basic usage
65
+
### Basic usage
66
66
67
67
-`ADDONS` - Customize Plone via Plone add-ons using this environment variable.
68
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.
@@ -75,24 +75,25 @@ Run Plone and install two add-ons (`eea.facetednavigation` and `collective.easyf
For advanced usage, the images support the following environment variables.
94
95
95
-
**Plone:**
96
+
#### Plone
96
97
97
98
-`PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using these environment variables.
98
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.
-`HEALTH_CHECK_TIMEOUT` - Time in seconds to wait until health check starts. Defaults to `1` second.
114
115
-`HEALTH_CHECK_INTERVAL` - Interval in seconds to check that the Zope application is still healthy. Defaults to `1` second.
115
116
116
-
**CORS:**
117
+
#### CORS
117
118
118
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`.
119
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`.
-`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`.
123
124
-`CORS_MAX_AGE` - Indicates how long the results of a preflight request can be cached. Defaults to `3600`.
124
125
125
-
**RELSTORAGE:**
126
+
#### RelStorage
126
127
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.
128
129
129
130
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).
130
131
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`.
135
136
136
137
[See more RelStorage options](https://relstorage.readthedocs.io/en/latest/relstorage-options.html).
0 commit comments