
=============================
Plone 2.5.2 Unified Installer
=============================
Maintainer: Kamal Gill (kamalgill at mac.com)
Feedback/bug reports: http://dev.plone.org/plone
This document last modified: 29 January 2007


Important: Back up your existing Plone site prior to running the installer.

Installation Instructions
=========================
To install Plone 2.5.2, cd to the installer directory and issue the following command:
	>> sudo ./install.sh  (or `su; ./install.sh` on a sudo-less system)

The installer will compile Python, Zope, and all required libraries from source.


Upgrade Instructions
====================
Installer-based automatic upgrades are not supported. To upgrade your site, you will need to complete the following steps:

1) Install Plone with the Unified Installer (default location: /opt/Plone-2.5.2)

2) Stop the existing Plone instance at /opt/Plone-2.5
	>> sudo /opt/Plone-2.5/zeocluster/bin/shutdowncluster.sh

3) Copy your Data.fs file from /opt/Plone-2.5/zeocluster/server/var/Data.fs to /opt/Plone-2.5.2/zeocluster/server/var
	>> cp /opt/Plone-2.5/zeocluster/server/var/Data.fs /opt/Plone-2.5.2/zeocluster/server/var/Data.fs

4) Migrate any third-party or custom products to the new setup
	>> cp -r /opt/Plone-2.5/zeocluster/Products/<CUSTOM_PRODUCT> /opt/Plone-2.5.2/zeocluster/Products/<CUSTOM_PRODUCT>

5) Start the new Plone instance at /opt/Plone-2.5.2
 	>> sudo /opt/Plone-2.5.2/zeocluster/bin/startcluster.sh

6) Click the 'Upgrade' button in the 'Migrate' tab in portal_migration (ZMI).
7) Click the 'Upgrade' button in the 'Version Migration' tab in portal_atct (ZMI).
8) Reinstall updated products in Plone at Site Setup -> Add/Remove Products (or via portal_quickinstaller in ZMI)

Note: Instructions on how to upgrade from versions prior to Plone 2.5 are beyond the scope of this document.


Dependencies
============
1) gcc
2) g++ (gcc-c++)
3) make


Recommended libraries (install prior to running installer)
==========================================================
1) readline (Python command-line history)
     libreadline5 libreadline5-dev readline-common


Install Location
================
- Plone installed at /opt/Plone-2.5.2
- Python installed at /opt/Plone-2.5.2/Python-2.4.4
- ZEO cluster (server and 2 clients) installed and configured at /opt/Plone-2.5.2/zeocluster
- Zope Products folder at /opt/Plone-2.5.2/zeocluster/Products
- Data.fs (ZODB) at /opt/Plone-2.5.2/zeocluster/server/var


Admin Password
==============
A random administrator password is generated during the install.  The password is located at

 /opt/Plone-2.5.2/adminPassword.txt


Startup/Shutdown/Restart instructions
=====================================
To start Plone, 
	>> sudo /opt/Plone-2.5.2/zeocluster/bin/startcluster.sh

To stop Plone,
	>> sudo /opt/Plone-2.5.2/zeocluster/bin/shutdowncluster.sh

To restart Plone,
	>> sudo /opt/Plone-2.5.2/zeocluster/bin/restartcluster.sh


Ports
=====
- ZEO server runs on port 8100
- ZEO client1 runs on port 8080
- ZEO client2 runs on port 8081


Post-installation instructions
==============================
You will need to manually add a Plone site to the ZEO cluster by logging on as manager at

http://localhost:8080/manage_main

(Use the admin password provided at /opt/Plone-2.5.2/adminPassword.txt)

Select "Plone site" from the "Add item" drop-down menu near top right to add a Plone site.
This only needs to be done once (per ZEO cluster) for each Plone site you wish to add.

To change the admin password, click the "Password" link for the admin user at

http://localhost:8080/acl_users/users/manage_users 


Third-party products installed
==============================
- PIL (Python Imaging Library)
- PyXML (XML processing)
- ReportLab (PDF toolkit)
- TextIndexNG3 (full-text indexing module)
- CacheFu (HTTP acceleration product suite)


Tested on the following operating environments
==============================================
- Ubuntu 6.06, 6.10
- Fedora Core 5, 6
- SUSE Linux 10.1/10.2
- FreeBSD 6.0/6.1 (and PC-BSD 1.0, 1.1, 1.2)
- Mac OS X.4 (Intel/PPC)


Uninstall instructions
======================
1) Stop Plone
2) Remove folder /opt/Plone-2.5.2


Backup instructions
===================
1) Stop Plone
2) Back up folder /opt/Plone-2.5.2
   >> tar -zcvf Plone-2.5.2-backup.tgz /opt/Plone-2.5.2


Coexistence with System Python
==============================
The Python installed by the Unified Installer will *not* interfere with any other Python
on your system.  The Installer bundles Python 2.4.4, placing it at /opt/Plone-2.5.2/Python-2.4.4


Installer Bug reports
=====================
Please use the Plone issue tracker at http://dev.plone.org/plone for all bug reports.











