Skip to content

Commit bba6263

Browse files
ksuessksuess
committed
Do tables standard conform.
1 parent c89e82c commit bba6263

File tree

2 files changed

+60
-60
lines changed

2 files changed

+60
-60
lines changed

‎docs/install/containers/images/backend.md‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ We encourage users of the `Plone` images to familiarize themselves with the opti
3939

4040
### Main variables
4141

42-
| Environment variable | Zope option | Default value |
43-
| -------------------------------- | -------------------------------- | ------------- |
44-
| `DEBUG_MODE` | `debug-mode` | `off` |
45-
| `SECURITY_POLICY_IMPLEMENTATION` | `security-policy-implementation` | `C` |
46-
| `VERBOSE_SECURITY` | `verbose-security` | `false` |
47-
| `DEFAULT_ZPUBLISHER_ENCODING` | `default-zpublisher-encoding` | `utf-8` |
48-
| `LISTEN_PORT` | (no equivalent) | `8080` |
42+
| Environment variable | Zope option | Default value |
43+
| --- | --- | --- |
44+
| `DEBUG_MODE` | `debug-mode` | `off` |
45+
| `SECURITY_POLICY_IMPLEMENTATION` | `security-policy-implementation` | `C` |
46+
| `VERBOSE_SECURITY` | `verbose-security` | `false` |
47+
| `DEFAULT_ZPUBLISHER_ENCODING` | `default-zpublisher-encoding` | `utf-8` |
48+
| `LISTEN_PORT` | (no equivalent) | `8080` |
4949

5050
#### Listen port
5151

@@ -67,12 +67,12 @@ docker run -p 8081:8081 -e LISTEN_PORT=8081 plone/plone-backend:{PLONE_BACKEND_M
6767

6868
### Site creation variables
6969

70-
| Environment variable | Description |
71-
| -------------------- | ------------------------------------------------------------------------------- |
72-
| `SITE` | Id of the site to be created, for example, `Plone` |
73-
| `TYPE` | Type of the site, either `classic` or `volto`. Default: `volto` |
74-
| `PROFILES` | Initialize site with additional profiles, for example, `eea.api.layout:default` |
75-
| `DELETE_EXISTING` | Force site to be recreated if it already exists, for example, `true` |
70+
| Environment variable | Description |
71+
| --- | --- |
72+
| `SITE` | Id of the site to be created, for example, `Plone` |
73+
| `TYPE` | Type of the site, either `classic` or `volto`. Default: `volto` |
74+
| `PROFILES` | Initialize site with additional profiles, for example, `eea.api.layout:default` |
75+
| `DELETE_EXISTING` | Force site to be recreated if it already exists, for example, `true` |
7676

7777
It is possible to initialize your database with a Plone Site instance on its first run.
7878
To do so, pass the `SITE` environment variable with the name of the Plone Site instance, for example, `SITE=Plone`.
@@ -99,22 +99,22 @@ We advise against using this feature on production environments.
9999

100100
### ZOPE variables
101101

102-
| Environment variable | Description | Default value |
103-
| -------------------- | ------------------- | ------------- |
104-
| `ZODB_CACHE_SIZE` | database cache size | `50000` |
102+
| Environment variable | Description | Default value |
103+
| --- | --- | --- |
104+
| `ZODB_CACHE_SIZE` | database cache size | `50000` |
105105

106106

107107
### ZEO variables
108108

109-
| Environment variable | Description | ZEO option | Default value |
110-
| ------------------------------- | ------------------------------------- | -------------------------- | ------------- |
111-
| `ZEO_ADDRESS` | URL of the ZEO interface, `host:port` | | |
112-
| `ZEO_SHARED_BLOB_DIR` | ZEO option | `name` | `off` |
113-
| `ZEO_READ_ONLY` | ZEO option | `read-only` | `false` |
114-
| `ZEO_CLIENT_READ_ONLY_FALLBACK` | ZEO option | `read-only-fallback` | `false` |
115-
| `ZEO_STORAGE` | ZEO option | `storage` | `1` |
116-
| `ZEO_CLIENT_CACHE_SIZE` | ZEO option | `cache-size` | `128MB` |
117-
| `ZEO_DROP_CACHE_RATHER_VERIFY` | ZEO option | `drop-cache-rather-verify` | `false` |
109+
| Environment variable | Description | ZEO option | Default value |
110+
| --- | --- | --- | --- |
111+
| `ZEO_ADDRESS` | URL of the ZEO interface, `host:port` | | |
112+
| `ZEO_SHARED_BLOB_DIR` | ZEO option |`name` | `off` |
113+
| `ZEO_READ_ONLY` | ZEO option |`read-only` | `false` |
114+
| `ZEO_CLIENT_READ_ONLY_FALLBACK` | ZEO option |`read-only-fallback` | `false` |
115+
| `ZEO_STORAGE` | ZEO option |`storage` | `1` |
116+
| `ZEO_CLIENT_CACHE_SIZE` | ZEO option | `cache-size` | `128MB` |
117+
| `ZEO_DROP_CACHE_RATHER_VERIFY` | ZEO option | `drop-cache-rather-verify` | `false` |
118118

119119

120120
#### Example
@@ -148,23 +148,23 @@ volumes:
148148
149149
### Relational Database variables
150150
151-
| Environment variable | Description | RelStorage option | Default value |
152-
| ------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------- | ------------- |
153-
| `RELSTORAGE_DSN` | {ref}`containers-images-backend-postgresql-dsn-label` for the database interface | | |
154-
| `RELSTORAGE_NAME` | RelStorage option | `name` | `storage` |
155-
| `RELSTORAGE_READ_ONLY` | RelStorage option | `read-only` | `off` |
156-
| `RELSTORAGE_KEEP_HISTORY` | RelStorage option | `keep-history` | `true` |
157-
| `RELSTORAGE_COMMIT_LOCK_TIMEOUT` | RelStorage option | `commit-lock-timeout` | `30` |
158-
| `RELSTORAGE_CREATE_SCHEMA` | RelStorage option | `create-schema` | `true` |
159-
| `RELSTORAGE_SHARED_BLOB_DIR` | RelStorage option | `shared-blob-dir` | `false` |
160-
| `RELSTORAGE_BLOB_CACHE_SIZE` | RelStorage option | `blob-cache-size` | `100mb` |
161-
| `RELSTORAGE_BLOB_CACHE_SIZE_CHECK` | RelStorage option | `blob-cache-size-check` | `10` |
162-
| `RELSTORAGE_BLOB_CACHE_SIZE_CHECK_EXTERNAL` | RelStorage option | `blob-cache-size-check-external` | `false` |
163-
| `RELSTORAGE_BLOB_CHUNK_SIZE` | RelStorage option | `blob-chunk-size` | `1048576` |
164-
| `RELSTORAGE_CACHE_LOCAL_MB` | RelStorage option | `cache-local-mb` | `10` |
165-
| `RELSTORAGE_CACHE_LOCAL_OBJECT_MAX` | RelStorage option | `cache-local-object-max` | `16384` |
166-
| `RELSTORAGE_CACHE_LOCAL_COMPRESSION` | RelStorage option | `cache-local-compression` | `none` |
167-
| `RELSTORAGE_CACHE_DELTA_SIZE_LIMIT` | RelStorage option | `cache-delta-size-limit` | `100000` |
151+
| Environment variable | Description | RelStorage option | Default value |
152+
| --- | --- | --- | --- |
153+
| `RELSTORAGE_DSN` | {ref}`containers-images-backend-postgresql-dsn-label` for the database interface | | |
154+
| `RELSTORAGE_NAME` | RelStorage option | `name` | `storage` |
155+
| `RELSTORAGE_READ_ONLY` | RelStorage option | `read-only` | `off` |
156+
| `RELSTORAGE_KEEP_HISTORY` | RelStorage option | `keep-history` | `true` |
157+
| `RELSTORAGE_COMMIT_LOCK_TIMEOUT` | RelStorage option | `commit-lock-timeout` | `30` |
158+
| `RELSTORAGE_CREATE_SCHEMA` | RelStorage option | `create-schema` | `true` |
159+
| `RELSTORAGE_SHARED_BLOB_DIR` | RelStorage option | `shared-blob-dir` | `false` |
160+
| `RELSTORAGE_BLOB_CACHE_SIZE` | RelStorage option | `blob-cache-size` | `100mb` |
161+
| `RELSTORAGE_BLOB_CACHE_SIZE_CHECK` | RelStorage option | `blob-cache-size-check` | `10` |
162+
| `RELSTORAGE_BLOB_CACHE_SIZE_CHECK_EXTERNAL` | RelStorage option | `blob-cache-size-check-external` | `false` |
163+
| `RELSTORAGE_BLOB_CHUNK_SIZE` | RelStorage option | `blob-chunk-size` | `1048576` |
164+
| `RELSTORAGE_CACHE_LOCAL_MB` | RelStorage option | `cache-local-mb` | `10` |
165+
| `RELSTORAGE_CACHE_LOCAL_OBJECT_MAX` | RelStorage option | `cache-local-object-max` | `16384` |
166+
| `RELSTORAGE_CACHE_LOCAL_COMPRESSION` | RelStorage option | `cache-local-compression` | `none` |
167+
| `RELSTORAGE_CACHE_DELTA_SIZE_LIMIT` | RelStorage option | `cache-delta-size-limit` | `100000` |
168168

169169

170170
```{note}
@@ -213,14 +213,14 @@ services:
213213
214214
### CORS variables
215215
216-
| Environment variable | Description | Default value |
217-
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- |
218-
| `CORS_ALLOW_ORIGIN` | Origins that are allowed access to the resource. Either a comma separated list of origins, for example `http://example.net,http://mydomain.com` or `*` | `http://localhost:3000,http://127.0.0.1:3000` |
219-
| `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` | `DELETE,GET,OPTIONS,PATCH,POST,PUT` |
220-
| `CORS_ALLOW_CREDENTIALS` | Indicates whether the resource supports user credentials in the request | `true` |
221-
| `CORS_EXPOSE_HEADERS` | A comma separated list of response headers clients can access, for example `Content-Length,X-My-Header` | `Content-Length,X-My-Header` |
222-
| `CORS_ALLOW_HEADERS` | A comma separated list of request headers allowed to be sent by the client, for example `X-My-Header` | `Accept,Authorization,Content-Type,X-Custom-Header` |
223-
| `CORS_MAX_AGE` | Indicates how long the results of a preflight request can be cached | `3600` |
216+
| Environment variable | Description | Default value |
217+
| --- | --- | --- |
218+
| `CORS_ALLOW_ORIGIN` | Origins that are allowed access to the resource. Either a comma separated list of origins, for example `http://example.net,http://mydomain.com` or `*` | `http://localhost:3000,http://127.0.0.1:3000` |
219+
| `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` | `DELETE,GET,OPTIONS,PATCH,POST,PUT` |
220+
| `CORS_ALLOW_CREDENTIALS` | Indicates whether the resource supports user credentials in the request | `true` |
221+
| `CORS_EXPOSE_HEADERS` | A comma separated list of response headers clients can access, for example `Content-Length,X-My-Header` | `Content-Length,X-My-Header` |
222+
| `CORS_ALLOW_HEADERS` | A comma separated list of request headers allowed to be sent by the client, for example `X-My-Header` | `Accept,Authorization,Content-Type,X-Custom-Header` |
223+
| `CORS_MAX_AGE` | Indicates how long the results of a preflight request can be cached | `3600` |
224224

225225
These variables are used to configure [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS).
226226

@@ -255,11 +255,11 @@ docker run -p 8080:8080 -e ADDONS="plone.volto==3.1.0a3" plone/plone-backend:{PL
255255

256256
#### Add-on variables
257257

258-
| Environment variable | Description | Details |
259-
| -------------------- | ---------------------------------------------------------------------- | --------------------------------------------------------------- |
260-
| `ADDONS` | A space separated list of python libraries to install | {ref}`containers-images-backend-add-ons-label` |
261-
| `DEVELOP` | A space separated list of python libraries to install in editable mode | {ref}`containers-images-backend-developing-packages-label` |
262-
| `PIP_PARAMS` | Parameters used in `pip` installation commands | [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/) |
258+
| Environment variable | Description | Details |
259+
| --- | --- | --- |
260+
| `ADDONS` | A space separated list of python libraries to install | {ref}`containers-images-backend-add-ons-label` |
261+
| `DEVELOP` | A space separated list of python libraries to install in editable mode | {ref}`containers-images-backend-developing-packages-label` |
262+
| `PIP_PARAMS` | Parameters used in `pip` installation commands | [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/) |
263263

264264
#### Adding configuration to `zope.conf` or additional ZCML
265265

‎docs/install/containers/images/frontend.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ This image is **not a base image** to be extended in your projects, but an examp
2121
### Main variables
2222

2323

24-
| Environment variable | Description | Example |
25-
| -------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------ |
26-
| `RAZZLE_API_PATH` | Used to generate frontend calls to the backend. Needs to be a public URL accessible by client browser. | `http://api.site.org/++api++/` |
27-
| `RAZZLE_INTERNAL_API_PATH` | Used by the middleware to construct requests to the backend. It can be a non-public address. | `http://backend:8080/Plone` |
28-
| `VOLTO_ROBOTSTXT` | Override the `robots.txt` file. | `"User-agent: *\nDisallow: "` |
24+
| Environment variable | Description | Example |
25+
| --- | --- | --- |
26+
| `RAZZLE_API_PATH` | Used to generate frontend calls to the backend. Needs to be a public URL accessible by client browser. | `http://api.site.org/++api++/` |
27+
| `RAZZLE_INTERNAL_API_PATH` | Used by the middleware to construct requests to the backend. It can be a non-public address. | `http://backend:8080/Plone` |
28+
| `VOLTO_ROBOTSTXT` | Override the `robots.txt` file. | `"User-agent: *\nDisallow: "` |
2929

3030
```{note}
3131
For an extensive list of environment variables used by the frontend, visit {doc}`/volto/configuration/environmentvariables`.

0 commit comments

Comments
 (0)