Avatar Resizer Plugin Readme

Overview

The avatar resizer plugin will scale down VCard-based avatars, when the corresponding vCard is stored in Openfire (it will not affect avatars that are being transferred between end-users).

Using avatars that are large can introduce problems for clients - not only will all of the data need to be transferred (which is done with inefficient base64-encoding), some clients have trouble displaying large sets. RAM and CPU spikes can occur as a result.

To prevent these problems, this plugin scales Avatars from vCards, but only if the vCards are provided by Openfire itself (through one of its VCardProvider implementations, which include the default, database-oriented provider, an LDAP provider and a Atlassian Crowd provider).

Avatar scaling of this plugin is in accordance with the guidelines listed in XEP‑0153: vCard-Based Avatars. Specifically, this plugin shrinks and crops the avatar to a 96 by 96 pixel square image (although the size is configurable, see below).

Installation

Copy avatarResizer.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 avatarResizer.jar file over the existing file.

Configuration

The plugin does not need configuration. Simply installing the plugin will enable it. The properties defined here can be set to override default behavior of the plugin.

Openfire properties for the Avatar Resizer plugin
Property nameDefault valueDescription
avatar.resize.targetdimension
96
Size (in pixels) of the resized avatar.

Credits

This plugin is based on an implementation by Aaron Sierra, which was contributed to IgniteRealtime through Mike Ray.

Icons made by Stephen Hutchings from www.flaticon.com, licensed by CC 3.0 BY.