Updated readme (w/ install documentation)

git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/branches@10270 b35dd754-fafc-0310-a699-88a17e54d16e

openfire_3_5_1/src/plugins/fastpath/readme.html

@@ -57,33 +57,60 @@ Fastpath Plugin Readme
 <h2>Overview</h2>
 
 <p>
-The monitoring plugin adds chat archiving support to Openfire together with a neat dashboard and
-a list of reports.
+The Fastpath plugin adds support for managed queued chat requests, such as
+a support team might use.  For example, a web based "Live Support" interface
+can point a potential customer at a workgroup representing the Sales team.
+Members of that workgroup will receive notification that a someone is
+waiting and when someone from that workgroup accepts, the customer and the
+team member will be connected to communicate with each other.
 </p>
 
 <h2>Installation</h2>
 
-<p>Copy monitoring.jar into the plugins directory of your Openfire installation. The
-plugin will then be automatically deployed. To upgrade to a new version, copy the new
-monitoring.jar file over the existing file.</p>
+<p>
+Copy fastpath.jar into the plugins directory of your Openfire installation. The
+plugin will then be automatically deployed. To upgrade to a new version, copy
+the new fastpath.jar file over the existing file.  <b>Make sure to follow the
+upgrading instructions under the Upgrading section, regardless of if
+you have the old Fastpath plugin or Enterprise installed currently or not.  
+The only time you can skip the Upgrading section is if you know for a fact
+that you have never run Fastpath or Enterprise.</b>
+</p>
+
+<p>
+Make sure that the enterprise plugin is removed before installing this plugin.
+Otherwise the enterprise plugin will rename the fastpath.jar to fastpath.jar.old
+thus removing thus plugin. If this happens just stop the server, remove the
+enterprise.jar plugin and rename fastpath.jar.old to fastpath.jar and start the
+server again.
+</p>
 
-<p>Make sure that the enterprise plugin is removed before installing this plugin. Otherwise
-the enterprise plugin will rename the fastpath.jar to fastpath.jar.old thus removing thus
-plugin. If this happens just stop the server, remove the enterprise.jar plugin and rename
-fastpath.jar.old to fastpath.jar and start the server again.</p>
+<h2>Upgrading from Pre-Enterprise Fastpath and Enterprise</h2>
 
-<h2>Configuration</h2>
+<p>
+Due to the previous version of Fastpath existing before it was incorporated
+into Enterprise, and due to this replacing part of the Enterprise plugin,
+upgrading to this Fastpath plugin requires some manual steps.  Effectively,
+we need to clean up the old database a bit and change the names of a couple of
+things.  So the steps you will need to perform are as follows: 
+<ol>
+<li>Shut down your server.</li>
+<li>Log into your database, you can use the embedded-db-viewer scripts in bin/extra to access the Embedded database.</li>
+<li>Execute the following SQL: <tt>DELETE FROM jiveVersion WHERE name = "fastpath"</tt></li>
+<li>Execute the following SQL (this may fail if you never had enterprise instaled, that is ok): <tt>UPDATE fpWorkgroupProp SET propValue = REPLACE(propValue, 'com.jivesoftware.openfire.fastpath','org.jivesoftware.openfire.fastpath')</tt></li>
+<li>Execute the following SQL (this may fail if you never had enterprise installed, that is ok): <tt>UPDATE fpAgentProp SET propValue = REPLACE(propValue, 'com.jivesoftware.openfire.fastpath','org.jivesoftware.openfire.fastpath')</tt></li>
+<li>Start up your server.  If you had enterprise installed, you -will- see an SQL error show up, but it should only show up once and is ok.  (it is an attempt to recreate a table that already exists)</li>
+</ol>
 
-Chat archiving is enabled by default. However, only meta data about conversations is
-enabled not include chat transcript archving. To enable chat transcript archiving
-or group chat archving you have to log into the admin console and go to
-Monitoring --> Archiving --> Archiving Settings..
+<b>You only need to do these steps once when moving to this Fastpath plugin.
+Do not repeat these steps on future Fastpath plugin updates.</b>
+</p>
 
 <h2>Configuration</h2>
 
-Run the corresponding migration script located in the database folder. You might need to start
-the server so that this plugin is exploded. You can also use an extracion tool like winzip to
-decompress this plugin and obtain the database scripts.
+Configuration is performed under the <b>Fastpath</b> tab in the Openfire
+admin console.  The quick start guide can be found
+<a href="http://www.igniterealtime.org/community/docs/DOC-1513">here</a>.
 
 </body>
 </html>