Browse Source

Plone: RestAPI support (#1594)

* Update Plone docs
Alin Voinea 6 years ago
parent
commit
be5eae5b90
1 changed files with 33 additions and 4 deletions
  1. 33 4
      plone/content.md

+ 33 - 4
plone/content.md

@@ -64,25 +64,45 @@ The Plone image uses several environment variable that allow to specify a more s
 ### For Basic Usage
 
 -	`ADDONS` - Customize Plone via Plone add-ons using this environment variable
+-	`SITE` - Add Plone instance with this id to `Data.fs` on first run. If NOT provided, you'll have to manually add a Plone Site via web UI
 -	`ZEO_ADDRESS` - This environment variable allows you to run Plone image as a ZEO client.
+-	`VERSIONS` - Use specific versions of Plone Add-on or python libraries
 
-Run Plone with ZEO and install two addons (PloneFormGen and collective.roster)
+Run Plone and install two addons (eea.facetednavigation and collective.easyform)
 
 ```console
-$ docker run --name=instance1 --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8080:8080 \
--e ADDONS="Products.PloneFormGen collective.roster" plone
+$ docker run -p 8080:8080 -e SITE="mysite" -e ADDONS="eea.facetednavigation collective.easyform" %%IMAGE%%
 ```
 
 To use specific add-ons versions:
 
 ```console
- -e ADDONS="Products.PloneFormGen==1.8.5 collective.roster==2.3.1"
+ -e ADDONS="eea.facetednavigation collective.easyform" \
+ -e VERSIONS="eea.facetednavigation=13.3 collective.easyform=2.1.0"
+```
+
+RestAPI:
+
+```console
+$ docker run -p 8080:8080 -e SITE=plone %%IMAGE%%
+
+$ curl -H 'Accept: application/json' http://localhost:8080/plone
 ```
 
 ### For Advanced Usage
 
+**Plone:**
+
+-	`PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using this environment variable
+-	`PLONE_SITE`, `SITE` - Add Plone with this id to `Data.fs` on first run. If NOT provided, you'll have to manually add a Plone Site via web UI
+-	`PLONE_VERSIONS`, `VERSIONS` - Use specific versions of Plone Add-on or python libraries
+-	`PLONE_PROFILES, PROFILES` - GenericSetup profiles to include when `SITE` environment provided.
 -	`PLONE_ZCML`, `ZCML` - Include custom Plone add-ons ZCML files (former `BUILDOUT_ZCML`)
 -	`PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons (former `BUILDOUT_DEVELOP`)
+
+**ZEO:**
+
+-	`ZEO_ADDRESS` - This environment variable allows you to run 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`.
@@ -92,6 +112,15 @@ To use specific add-ons versions:
 -	`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, e.g. `http://example.net,http://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, e.g. `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, e.g. `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, e.g. `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`
+
 ## Documentation
 
 Full documentation for end users can be found online at [docs.plone.org](https://docs.plone.org/manage/docker/docs/usage/index.html)