OfArchiver is a Python app that generates HTML archives of chat rooms on an Openfire instant messaging server.
Example usage is as follows:
from ofarchiver import OfArchiver
ofa = OfArchiver()
for room in ofa.get_rooms():
A script called ofarchiver is also installed, which takes advantage of the multiprocessing Python module to speed up archive generation on installations with many chat rooms. It can serve as a cron job to generate archives at a given interval.
sudo pip install OfArchiver
sudo easy_install OfArchiver
git clone http://github.com/egnyte/ofarchiver
python setup.py build
sudo python setup.py install
The Monitoring Service Openfire plugin must be installed and configured.
1. Log into the Openfire admin panel and select the Plugins tab.
2. Install the Monitoring Service plugin.
3. Select the Server tab, then the Archiving subtab.
4. Under Archiving Settings, enable Archive group chats.
An ofarchiver.ini configuration file is included which must be copied to one of the following locations (listed in the order in which they are checked):
- The user's home directory ($HOME)
It consists of the following sections (mandatory options have a **):
The base directory in which to generate the HTML archive.
The name of the Openfire conference server.
The type of database used by Openfire (only mysql is currently supported).
Whether to enable debugging statements.
A file in which to log informational and/or debugging messages.
The name of the organization running Openfire.
A list of rooms for which to generate archives.
The hostname of the MySQL server.
A MySQL user, either Openfire's or one created just for OfArchiver (only SELECT privileges on the ofMessageArchive table is needed).
The password for the MySQL user above.
The MySQL database used by Openfire.
Whether to enable colors to more easily differentiate chat room members.
A list of colors to choose from.
A web server with automatic directory index generation is required to view the HTML archive. Here is a sample configuration for Apache, with /var/www/html/ofarchive as the archive base directory:
< Directory /var/www/html/ofarchive >
IndexOrderDefault Descending Date
< /Directory >
Adding authentication and encryption is highly recommended.
· An Openfire server with chat rooms (tested with 3.7.0)
· MySQL as the Openfire database (tested with 5.0)
· A web server (tested with Apache 2.2 and its mod_autoindex module)