Skip to content

Commit 0069420

Browse files
stevepiercystevepiercy
committed
Comply with markdownfmt.sh. Using tabs instead of spaces is silly.
1 parent f9d7526 commit 0069420

File tree

2 files changed

+40
-40
lines changed

2 files changed

+40
-40
lines changed

‎plone/content.md

+35-35
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
## Features
88

9-
- Enable add-ons via environment variables.
10-
- Choose between [Debian](https://www.debian.org/) or [Alpine](http://www.alpinelinux.org/) based images.
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+).
9+
- Enable add-ons via environment variables.
10+
- Choose between [Debian](https://www.debian.org/) or [Alpine](http://www.alpinelinux.org/) based images.
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+).
1313

1414
## Usage
1515

@@ -64,10 +64,10 @@ The Plone image uses several environment variables.
6464

6565
### For basic usage
6666

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.
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.
7171

7272
Run Plone and install two add-ons (`eea.facetednavigation` and `collective.easyform`).
7373

@@ -94,46 +94,46 @@ $ curl -H 'Accept: application/json' http://localhost:8080/plone
9494

9595
**Plone:**
9696

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

104104
**ZEO:**
105105

106-
- `ZEO_ADDRESS` - This environment variable allows you to run the Plone image as a ZEO client.
107-
- `ZEO_READ_ONLY` - Run Plone as a read-only ZEO client. Defaults to `off`.
108-
- `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`.
109-
- `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_STORAGE` - Set the storage number of the ZEO storage. Defaults to `1`.
111-
- `ZEO_CLIENT_CACHE_SIZE` - Set the size of the ZEO client cache. Defaults to `128MB`.
112-
- `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-
- `HEALTH_CHECK_TIMEOUT` - Time in seconds to wait until health check starts. Defaults to `1` second.
114-
- `HEALTH_CHECK_INTERVAL` - Interval in seconds to check that the Zope application is still healthy. Defaults to `1` second.
106+
- `ZEO_ADDRESS` - This environment variable allows you to run the Plone image as a ZEO client.
107+
- `ZEO_READ_ONLY` - Run Plone as a read-only ZEO client. Defaults to `off`.
108+
- `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`.
109+
- `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_STORAGE` - Set the storage number of the ZEO storage. Defaults to `1`.
111+
- `ZEO_CLIENT_CACHE_SIZE` - Set the size of the ZEO client cache. Defaults to `128MB`.
112+
- `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+
- `HEALTH_CHECK_TIMEOUT` - Time in seconds to wait until health check starts. Defaults to `1` second.
114+
- `HEALTH_CHECK_INTERVAL` - Interval in seconds to check that the Zope application is still healthy. Defaults to `1` second.
115115

116116
**CORS:**
117117

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

125125
**RELSTORAGE:**
126126

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.
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.
128128

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

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`.
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`.
135135

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

138138
## Documentation
139139

‎plone/deprecated.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ⚠️ DEPRECATION NOTICE ⚠️
22

3-
- Plone 4.x is no longer supported.
4-
- Plone 5.x is out of maintenance support, and will exit security support on 2024-10-31.
5-
- It is strongly recommended to migrate to the latest available Plone version. See https://plone.org/download/release-schedule for details.
3+
- Plone 4.x is no longer supported.
4+
- Plone 5.x is out of maintenance support, and will exit security support on 2024-10-31.
5+
- It is strongly recommended to migrate to the latest available Plone version. See https://plone.org/download/release-schedule for details.
66

77
The official Docker images for Plone 5.x and Plone 4.x are available here, and are maintained by community volunteers.
88

99
Beginning with Plone 6.x, the frontend and backend run in separate Docker images, and are supported by the Plone Foundation.
1010

11-
- [Plone Backend](https://github.com/plone/plone-backend)
12-
- [Plone Frontend](https://github.com/plone/plone-frontend)
11+
- [Plone Backend](https://github.com/plone/plone-backend)
12+
- [Plone Frontend](https://github.com/plone/plone-frontend)

0 commit comments

Comments
 (0)