Registration Plugin Readme

Overview

The registration plugin allows admins to configure various actions whenever a new user creates an account.

Installation

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

Configuration

The registration plugin is configured via the "Registration Properties" sidebar item located in the "Users" sidebar item under the "Users/Groups" tab in the Openfire Admin Console. By default, after the registration plugin has been deployed all of its features are disabled. To enable a feature of the plugin select the checkbox next to the feature and then click on the "Save Settings" button. The registration plugin has various items that can be configured:

• Account expiry - Disables new accounts after a certain amount of time has passed.
• Registration Notification - Contacts can be configured to receive an instant message and/or email to notify them whenever a new user registers.
• Welcome Message - A message that will be sent to a user when they first register.
• Default Group - A group that all users will be added to when they first register.
• Web Page Registration - Allows users to create accounts via a web page.
• Default Privacy List - A privacy list added and set as default for all users when they register.

Public web registration form

The plugin can make available a public web page that can be used by your users to register new accounts. Optionally, Google's reCAPTCHA v3 verification service can be used to protect against abuse of this service.

To enable the reCAPTCHA verification, you should follow the instructions provided by Google, at https://www.google.com/recaptcha/. At the moment of writing, the process to sign up for the service is:

1. Open the reCAPTCHA Admin Console
2. Create a new site
3. Select as type: v3
4. Fill out the domain name on which the public signup page will be accessible
5. Copy the 'site key' and 'secret key', and save this in the Openfire Admin Console

It is advisable to manually test the sign-up page afterwards, by creating a new user.

Default Privacy List

The format used is an XML that should look like :

<list>
<item action="deny" order="100" type="subscription" value="none">
     <message/>
     <presence-in/>
     <presence-out/>
</item>
</list>

The enclosing list tag is needed, but none of its attributes are read. Inside it you can have multiple items.

Using the Plugin

Presently, after the registration plugin has been configured nothing else needs to be done to use it.