Skip to main content

Introduction

OfArchiver 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():
    ofa.gen_archive(room)

A script called ofarchiver is also installed, which takes advantage of the multiprocessing Python module to speed up archive generation on installations with multiple chat rooms. It can serve as a cron job to generate archives at a given interval.

Requirements

  • 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).

  • Python 2.6 or higher (available for RHEL/CentOS 5 in EPEL as python26).

Installation

  • With pip:

    sudo pip install OfArchiver
  • With easy_install:

    sudo easy_install OfArchiver
  • From source:

    git clone http://github.com/egnyte/ofarchiver
    cd ofarchiver
    python setup.py build
    sudo python setup.py install

Configuration

Openfire

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.

OfArchiver

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):

  • /usr/local/etc

  • /etc

  • The user’s home directory ($HOME)

It consists of the following sections (mandatory options have a **):

main

basedir **

The base directory in which to generate the HTML archive.

confserver **

The name of the Openfire conference server.

db **

The type of database used by Openfire (only mysql is currently supported).

debug

Whether to enable debugging statements.

logfile

A file in which to log informational and/or debugging messages.

org

The name of the organization running Openfire.

rooms

A list of rooms for which to generate archives.

db

hostname **

The hostname of the MySQL server.

username **

A MySQL user, either Openfire’s or one created just for OfArchiver (only SELECT privileges on the ofMessageArchive table is needed).

password **

The password for the MySQL user above.

database **

The MySQL database used by Openfire.

colors

enabled

Whether to enable colors to more easily differentiate chat room members.

names

A list of colors to choose from.

Web Server

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>
  Options +Indexes
  IndexOptions FancyIndexing
  IndexOrderDefault Descending Date
</Directory>

Adding authentication and encryption is highly recommended.

Thanks

  • Egnyte for allowing and encouraging me to release this software.

Release files for ofarchiver 0.43

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ofarchiver 0.43
File Size Uploaded
ofarchiver-0.43.tar.gz 12.6 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for ofarchiver 0.43
File Interpreter ABI Platform
ofarchiver-0.43-py2.7.egg Legacy Egg format - - Details
ofarchiver-0.43-py2.6.egg Legacy Egg format - - Details

Total release size: 38.0 kB

Release files / ofarchiver-0.43.tar.gz

Download URL ofarchiver-0.43.tar.gz
Size 12.6 kB
Tags Source
SHA-256 checksum
How to use checksums
ced7141f47b9f180dc82c34d7aa13747dbe4558c141f06565e2bf5698fa5d3d7
BLAKE2b-256 checksum
How to use checksums
38df4e88f8f49300c190e35f44b128e1c58edd11c9eb6131f825793b1ee6a7bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ofarchiver-0.43-py2.7.egg

Download URL ofarchiver-0.43-py2.7.egg
Size 12.7 kB
Tags Egg
SHA-256 checksum
How to use checksums
43e700a0083fd60732c89f4398491724d66320b915dfa53d24ac7b7fbb04a84b
BLAKE2b-256 checksum
How to use checksums
b1762640c91ffc8766a5913eb7375d76b204646877dad4097d6478ea7cddf41c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ofarchiver-0.43-py2.6.egg

Download URL ofarchiver-0.43-py2.6.egg
Size 12.7 kB
Tags Egg
SHA-256 checksum
How to use checksums
abf738da31ae0dfc5761ab4813af561ee4657a2df65b72f627f881ef36ec38db
BLAKE2b-256 checksum
How to use checksums
524617662883a214370553a7051bbf67dd4a8de5feef82533d20a8230111cb1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.43 This release

3 release files

0.42

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page