toutpt / collective.etherpad

Etherpad integration in Plone
4 stars 4 forks source link

Introduction

This addon integrate etherpad_ into the Plone CMS. It is a way to get Collaborating in really real-time on document.

About Etherpad

Etherpad is an Open Source online editor providing collaborative editing in really real-time powered by Node.js

How to install

.. image:: https://secure.travis-ci.org/toutpt/collective.etherpad.png :target: http://travis-ci.org/toutpt/collective.etherpad

This addon can be installed as any other Plone addons. Please follow the official documentation_.

You must install etherpad-lite and configure it. If you want to deploy it using buildout you can referer to the provided buildout of this addon on github. It is important that your etherpad is on the same domain as your Plone site (using a reserved path) to let cookies working properly and so your users being authenticated in Plone to be authenticated in etherpad.

You will probably have to install etherpad dependencies: NodeJS <http://nodejs.org/>_ and NPM <https://npmjs.org/>. Under Linux, type ::

apt-get install nodejs npm

How to configure

A set of configuration is available on the configuration registry of Plone (/portal_registry). You should review theses settings and integrate them in your site policy.

Set as value for collective.etherpad.settings.EtherpadSettings.apikey the content of the APIKEY.txt file that fits in the etherpad install folder. If you have installed etherpad with buildout, you'll find it at collective.etherpad/parts/etherpad-lite/APIKEY.txt.

Credits

Companies

|makinacom|_

Authors

.. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif .. _makinacom: http://www.makina-corpus.com .. _etherpad: http://etherpad.org/ .. _documentation: http://plone.org/documentation/kb/installing-add-ons-quick-how-to