From 9902f062d48cc58d9d5036b5f2e9641d610bbb7c Mon Sep 17 00:00:00 2001 From: Alin Voinea Date: Wed, 12 Oct 2016 21:09:26 +0300 Subject: [PATCH] Add an official image for Plone (#484) * Add Plone * Fix markdown fmt * Update documentation about data storage * Fix markdown fmt * Add supported environment variables. * Fix site.cfg path * Update Plone documentation based on latest changes within repo. * Fix usage examples * Fix Add-ons example * Update docs with info about ZEO cluster * Revert update.sh * Add required github-repo * Add supported environment variables * Add some credits * Fix github users links * Markdown fmt --- plone/README-short.txt | 1 + plone/content.md | 82 +++++++++++++++++++++++++++++++++++++++++ plone/github-repo | 1 + plone/license.md | 1 + plone/logo.png | Bin 0 -> 3243 bytes 5 files changed, 85 insertions(+) create mode 100644 plone/README-short.txt create mode 100644 plone/content.md create mode 100644 plone/github-repo create mode 100644 plone/license.md create mode 100644 plone/logo.png diff --git a/plone/README-short.txt b/plone/README-short.txt new file mode 100644 index 000000000..fb0da8a94 --- /dev/null +++ b/plone/README-short.txt @@ -0,0 +1 @@ +Plone is a free and open source content management system built on top of Zope. diff --git a/plone/content.md b/plone/content.md new file mode 100644 index 000000000..da68a8c46 --- /dev/null +++ b/plone/content.md @@ -0,0 +1,82 @@ +# What is Plone? + +[Plone](https://plone.org) is a free and open source content management system built on top of the Zope application server. + +%%LOGO%% + +## Features + +- Images for Plone 5 and Plone 4 +- Enable add-ons via environment variables + +## Usage + +### Start a single Plone instance + +This will download and start the latest Plone 5 container, based on [Debian](https://www.debian.org/). + +```console +$ docker run -p 8080:8080 plone +``` + +This image includes `EXPOSE 8080` (the Plone port), so standard container linking will make it automatically available to the linked containers. Now you can add a Plone Site at http://localhost:8080 - default Zope user and password are `admin/admin`. + +### Start Plone within a ZEO cluster + +Start ZEO server + +```console +$ docker run --name=zeo plone zeoserver +``` + +Start 2 Plone clients + +```console +$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8100 -p 8081:8080 plone +$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8100 -p 8082:8080 plone +``` + +### Start Plone in debug mode + +You can also start Plone in debug mode (`fg`) by running + +```console +$ docker run -p 8080:8080 plone fg +``` + +### Add-ons + +You can enable Plone add-ons via the `PLONE_ADDONS` environment variable + +```console +$ docker run -p 8080:8080 -e PLONE_ADDONS="eea.facetednavigation Products.PloneFormGen" plone +``` + +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://github.com/plone/plone.docker/blob/master/docs/usage.rst). + +### Supported Environment Variables + +The Plone image uses several environment variable that allow to specify a more specific setup. + +- `PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using this environment variable +- `PLONE_ZCML`, `ZCML` - Include custom Plone add-ons ZCML files +- `PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons +- `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`. +- `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. + +## Documentation + +Full documentation for end users can be found in the ["docs"](https://github.com/plone/plone.docker/tree/master/docs) folder. It is also available online at http://docs.plone.org/ + +## Credits + +This docker image was originally financed by the [European Environment Agency](http://eea.europa.eu), an agency of the European Union. + +Thanks to [Antonio De Marinis](https://github.com/demarant), [Sven Strack](https://github.com/svx) and [Alin Voinea](https://github.com/avoinea) for their preliminary work. diff --git a/plone/github-repo b/plone/github-repo new file mode 100644 index 000000000..eb2517806 --- /dev/null +++ b/plone/github-repo @@ -0,0 +1 @@ +https://github.com/plone/plone.docker diff --git a/plone/license.md b/plone/license.md new file mode 100644 index 000000000..73b2f0ca0 --- /dev/null +++ b/plone/license.md @@ -0,0 +1 @@ +View [license information](https://plone.org/foundation/copyrights/license-faq) for the software contained in this image. diff --git a/plone/logo.png b/plone/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9e303f7cedb8c0292848930560c210e6dba9506b GIT binary patch literal 3243 zcmV;c3{>-pP)00009a7bBm000XU z000XU0RWnu7ytkOGf+%aMF4}o5R1Yflg2Qb%0QydP^!{kvet09+ke5{kICYn(C4q% z>%ZXd&*<~t@AvQb`~Uy{(@;9j000agNkltYd$F zI%~Vmj5y|j`;%F3f)x$1jk*0u)^43x@tBkw)B9)oGh>wehy#wl$PNd&ZZqxaYFg?e5N$W3@>gr&{|QmMus8qNJ*POdMv$;czx$Fkm)fMxrab>J`y zeGmr~U3tgn-tInAWLaWmPJw(3YbV$w7hse5Wvw#aGJk%upUz1Ibs}p-!;d%iQ&_wC zD`~(Arhi!bGFC)3%aPle@VBB=p=)6sY6$9)tYLBs0EitWw=BA?V<5~?K#8)%c;m({ zVjUbx(-T=6W)LQ&_=IkfEXrZS{;YlNuXtmZu?{qZ{ei5P84&<+Wr!>PV!dW1cn8+L z6j$f6_5(TUfviCx!fedU5e@rdJrVrXuDN2%^S4hYv-X4)JeBo#w#hf^jYN(Y#tpNc zFMTd+-!=O{)(tZx;H%Ke6#1WR()AJEj;~nI<92IsBY-jH%?2*1O^=iXLa~>BN$_B(ul}> z5iUv`kLBvLs2Aclvo>+vlrOf3wT_*HGjR@eyy`jg^`9a)=1aN_3t^X8PFsB#`&QOR z4Mi45W}R#+1%$nA(mkmr3I*mp5YLD)Xsrq1Nt?GnYtfDMaZXHf61;bHqQM{KL~FY# z=J`IeiGr^(NET}rvRW;=PY<`*uDik!SnpFqn~^=&z9zrxm^X!lZK}opN=1btx>ftc zZ?ms=LYJU;i;!0pHup30p+4Q-Ta0;&pB8-DlO^ig0uy61q?N^)81?s^&_``Q%@2{8-sx;qqZ9<)!6lVLi81&Dh zxVoTfE$n;ZT#nr4Eh5H?lbiRZ<(4sunCa#&)HJzP{fGC&uM3(tF72$Na@EoM{~ngN zGgWb1ljTh8uU)Mmxg{^9r~qMWW*yy_VfE}Jl{Q+5sYt(LOYQNQncDOr#!Isjt62N8 zw=Ul-EN5i1GR9f6EmJ;EK0YU6H3oO1uHS46TGshz7B-UG>{BWD; z(%}CM&$5;tiZy%ao1BoBR9*bl>Z?}6)7mOzn4Q5o(t@e3?qkVm+P;RYGpu!1&6$t4 zwa!iqr+McKlLu%9pgsO|~8b($N&_}$1yMe4v3hYTd)#Cuhi=95_;Sb*Xj)@AkAu8Os!ND??$*`yTA z<8(hx@jPjgf2tGf68C_qwCEdHSN2tyDCeL#SlKjpwLDPHHk!YCqMXF%vz~i7&Mxnl zVrhYeIjxE3E2qL^0Mgo_q0J3En6<(>)*CI_yAs`VoHl!qTu29nGL~{KK0t;qSjn1b z9Pa5QL5$y~y-SW7vYZJo^!IhM`o4vN==33mSQO2QnUZt0QUg8fsjNkT1ih4X;w}Qx zTT@+%klcJk)@cEvsB|>pSo~W!HVFPuGY4VF>nwgQw zaiu^Y+lJ;m)|IA5;-!1#D#Q!>Vl5i_1*C_`{Chq5= z)xnjs#yeQMzN}BpE!d)f75-5$SgX1#S_-Q1&+ zyx=bGQQ62Ehz1HVFQtaH>i5cDtebn!$~s)9_nz&^dM5su>dIR8b83Fyepc7ty|bwU>%MiGRje)DNOhLP`VZd4 zR=`>jS7&4Wbrox}^8?+S^I+2NSTv32^|f~_matBrKwbMP)UjTP`mCF??&{0#PF-2! zw(iOrXv@wsGu!&5)UkG)1pDi<*kjlQcOuUPbvzj(^yE8{^W&(z{lNB^JYGQ`B-fpF z;MRz}xKk9ftl+Nmbbj_*-E~eHo|H*;_V3x>tdezL>jsH@?%$Tbn!q|}ycq~ATYp>! z!O$8@u_tT)UAWZW`Q_Pn7OQcH)~Goj@$11lvd5<7_qUvXRg5OEw%Mw?l#?{CW(6C- z-po3EAd!U`#eLX?b-X3y{B>&+r&Q1dti#umIYCU-%p_}8%zCrd)KsmRj#}U;tcx=Y z*F5WR_eoNuOBAD?@pjh9BI2B;ogTUV;nl1QD^zDkU>!Eq1()9qb4G#(SN|mZ?botS zZtUt^6|;9bu|5hhhFi}OWO!`f&RN(ZhkB+TC|9yhHGwY>_xZHDUaSjXONt(j80$*z zzry~Cj_1zmhzOMU7OWFpu#(5@7cH z%_GWT0qf{u=amVJ8*j}fKbJM4;>7Zph>tApOFNHs;@VZpVJDg`;eVcP~(vw z<7U<|cj@c?hDEJE{o_`(0Izn_j&V2Zs3)X$a6M-FommGrHP(;Wj){J6)=?K?%}`^S z-=B4ttqo&Se*|m9ZE7PuZDWo};1Nz=*Hu(Upibp!1|`r}w5y0t=*PwOE4fvoYs z%iZ8PALBh)N29k%dwLzZ_eZnFM4&vdu?FbBz#1_~