## $Id$


Introduction
============

SharedDocumentBase  enables  several Plone  site  to  share a  comment
"document  base". Changes  in one  Plone  will be  reflected in  other
Plone. Conflicts will be handled  as best as possible, but editing the
same document on two Plone at the same time may lead to trouble.
  

Dependencies
============

SharedDocumentBase requires z3c.sqlalchemy and SQLAlchemy 0.3.10.

It was tested on Plone 3.0 only, but should work on 3.1 too.

A SQL-Alchemy compatible database server is required.

Installation
============

Database setup
--------------

The first step is to setup a SQL database server, create a database in
it, and initialize it with schema in sql/schema.sql. This file is for
MySQL, but can be adapted easily to any other SQL database back-end.

Zope instance setup
-------------------

You  need to install  SQLAlchemy 0.3.10  in your  Python path,  and to
install z3c.sqlalchemy inside the lib/python of your instance.

Then you can put SharedDocumentBase inside the Products/ directory, and
restart your Zope instance.

Plone site setup
----------------

To automatically synchronize data, you need to create a user "robot" with
Manager role, and setup the following lines in the zope.conf file (once
per Plone site) ::

    <clock-server>
        method /<plone>/portal_shared_document_base/replayScript
        period 300
        user robot
        password <password>
        host localhost
    </clock-server>

Then you can install SharedDocumentBase using the "Add/Remove products".

To configure SharedDocumentBase, you need to go in ZMI to the 
portal_shared_document_base tool, enter the SQL Alchemy connection string,
and then go to the *Initial setup* tab and click on *Perform initial setup*.

Future versions
===============

- Support of more recent SQLAlchemy

- Easier installation process