Commit 81249a5f authored by Daniel Henninger's avatar Daniel Henninger Committed by dhenninger

Prepwork for 1.0.0 release.


git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/branches/openfire_3_5_1@10266 b35dd754-fafc-0310-a699-88a17e54d16e
parent 7a5b9773
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
Monitoring Plugin Changelog Monitoring Plugin Changelog
</h1> </h1>
<p><b>1.0</b> -- April 21, 2008</p> <p><b>1.0.0</b> -- April 24, 2008</p>
<ul> <ul>
<li>Initial release. </li> <li>Initial release. </li>
......
...@@ -6,14 +6,14 @@ ...@@ -6,14 +6,14 @@
<description>Monitors conversations and statistics of the server.</description> <description>Monitors conversations and statistics of the server.</description>
<author>Jive Software</author> <author>Jive Software</author>
<version>1.0.0</version> <version>1.0.0</version>
<date>4/21/2008</date> <date>4/24/2008</date>
<minServerVersion>3.5.1</minServerVersion> <minServerVersion>3.5.1</minServerVersion>
<databaseKey>monitoring</databaseKey> <databaseKey>monitoring</databaseKey>
<databaseVersion>0</databaseVersion> <databaseVersion>0</databaseVersion>
<adminconsole> <adminconsole>
<tab id="tab-monitoring" name="${admin.tab.monitoring.name}" url="stats-dashboard.jsp" description="${admin.tab.monitoring.description}"> <tab id="tab-server">
<sidebar id="stats-dashboard" name="${admin.item.stats-dashboard.name}" description="${admin.item.stats-dashboard.description}"> <sidebar id="stats-dashboard" name="${admin.sidebar.statistics.name}" description="${admin.item.stats-dashboard.description}">
<item id="statistics" name="${admin.sidebar.statistics.name}" <item id="statistics" name="${admin.sidebar.statistics.name}"
url="stats-dashboard.jsp" url="stats-dashboard.jsp"
description="${admin.sidebar.statistics.description}"/> description="${admin.sidebar.statistics.description}"/>
......
...@@ -57,22 +57,68 @@ Monitoring Plugin Readme ...@@ -57,22 +57,68 @@ Monitoring Plugin Readme
<h2>Overview</h2> <h2>Overview</h2>
<p> <p>
The monitoring plugin adds chat archiving support to Openfire together with a neat dashboard and The monitoring plugin adds support for chat archiving and server statistics to
a list of reports. Openfire. It provides support for generating various reports on the server
statistics, as well as managing, viewing, and reporting on chat logs.
</p> </p>
<h2>Installation</h2> <h2>Installation</h2>
<p>Copy monitoring.jar into the plugins directory of your Openfire installation. The <p>
plugin will then be automatically deployed. To upgrade to a new version, copy the new Copy monitoring.jar into the plugins directory of your Openfire installation.
monitoring.jar file over the existing file.</p> 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>
Make sure that the enterprise plugin is removed before installing this plugin.
Otherwise the enterprise plugin will rename the monitoring.jar to
monitoring.jar.old thus removing thus plugin. If this happens just stop the
server, remove the enterprise.jar plugin and rename monitoring.jar.old to
monitoring.jar and start the server again.
</p>
<h2>Upgrading from Enterprise</h2>
<p>
If you are upgrading from the Enterprise plugin, and wish to keep your old
statistics and logs, you will need to manually run some database scripts to
perform the migration. Note, if you don't care about your previous
statistics and chat logs, you don't have to worry about these steps.
</p>
<p>
First, you will need to shut down your Openfire server and remove the
enterprise plugin. To do this, after shutting down, remove the
<b>enterprise.jar</b> file and the <b>enterprise</b> directory from the
plugins directory in your Openfire install root. Then install this plugin,
<b>monitoring.jar</b> by copying it into the plugins directory. At this point,
you will need to start up Openfire and let it extract and install the
<b>monitoring</b> plugin. You can watch for this to occur by looking under
the Plugins tab in the Openfire admin console. Once it appears in the list,
you should be good to go. Shut the server back down at this point. Then
go into your plugins/monitoring/database directory. There you will see
some scripts prefixed with <b>import_</b>. Log into your database, switch
to the Openfire's database as you configured during setup (you can find
this information in conf/openfire.xml if you don't remember it), and run
the script that matches the database you are using. Note that the embedded
database is hsqldb and you can use the script in bin/extra from the Openfire
install root (bin/extra/embedded-db-viewer.sh or
bin/extra/embedded-db-viewer.bat, depending on whether you are using Windows)
to access your embedded database. Once the script has completed, you can
start Openfire back up and all of your settings should be the way they were
when you were running the Enterprise plugin.
</p>
<h2>Configuration</h2> <h2>Configuration</h2>
Chat archiving is enabled by default. However, only meta data about conversations is <p>
enabled not include chat transcript archving. To enable chat transcript archiving Chat archiving is enabled by default. However, only information about
or group chat archving you have to log into the admin console and go to who is communicating and at what time is stored unless chat transcript
Monitoring --> Archiving --> Archiving Settings.. archiving is enabled. To enable chat transcript archiving or group chat
archiving, you will need to log into the admin console and go to:<br />
Server --&gt; Archiving --&gt; Archiving Settings
</p>
</body> </body>
</html> </html>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment