Skip to content

Commit

Permalink
Comply with markdownfmt.sh. Using tabs instead of spaces is silly.
Browse files Browse the repository at this point in the history
  • Loading branch information
@stevepiercy
stevepiercy committed Aug 5, 2024
1 parent f9d7526 commit 0069420
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 40 deletions.
70 changes: 35 additions & 35 deletions plone/content.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

## Features

- Enable add-ons via environment variables.
- Choose between [Debian](https://www.debian.org/) or [Alpine](http://www.alpinelinux.org/) based images.
- Built-in RelStorage support, configurable via environment variables (requires Plone 5.2.4+).
- Built-in LDAP/AD support via `pas.plugins.ldap` (requires Plone 5.2.4+).
- Enable add-ons via environment variables.
- Choose between [Debian](https://www.debian.org/) or [Alpine](http://www.alpinelinux.org/) based images.
- Built-in RelStorage support, configurable via environment variables (requires Plone 5.2.4+).
- Built-in LDAP/AD support via `pas.plugins.ldap` (requires Plone 5.2.4+).

## Usage

Expand Down Expand Up @@ -64,10 +64,10 @@ The Plone image uses several environment variables.

### For basic usage

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

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

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

**Plone:**

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

**ZEO:**

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

**CORS:**

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

**RELSTORAGE:**

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

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

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

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

## Documentation

Expand Down
10 changes: 5 additions & 5 deletions plone/deprecated.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# ⚠️ DEPRECATION NOTICE ⚠️

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

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

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

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

2 comments on commit 0069420

@whalelines
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://adamtuttle.codes/blog/2021/tabs-vs-spaces-its-an-accessibility-issue/

@stevepiercy
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. What's the local command to reformat code? These commands only check formatting: https://github.com/docker-library/docs?tab=readme-ov-file#markdownfmtsh-and-ymlfmtsh.
  2. I would suggest that instead of merely running checks in CI, that you make it reformat code. This will save electricity, review cycles, and satisfy all contributors.

It's silly to make contributors do the work that is best handled by computers. Thanks for your consideration.

Please sign in to comment.