# Candy Plugin Readme

## Overview

The Candy plugin adds the web client to Openfire. Candy is a third party web client implementation. It's project home page is https://candy-chat.github.io/candy/

## Installation

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

## Configuration

The plugin is configured via the Openfire Admin Console. After installation, a new Admin Console page is available. The page can be found on a main menu in the "Web Clients" tab. The name of the page is "Candy".

### Important! Before the plugin can be used, it must be configured!

When logged in, users of the Candy web chat will automatically join one or more pre-defined Group Chat Rooms. When installing the Candy plugin, you must configure what rooms the Candy users will join. This is done in two steps:

1. Create the Group Chat Room(s) that you wish to use. If desired, existing rooms can be used. In Openfire, Group Chat Rooms are managed in the Admin Console, via the tab "Group Chat".
2. In the "Candy" Admin Console configuration page ('Server' > 'Web Clients' > 'Candy'), add the names of the Group Chat Rooms to the list of Auto-join rooms.

Candy depends on HTTP binding, and will not work if the HTTP binding service of Openfire is disabled. It can be enabled on the Server > Server Settings > HTTP Binding page.

## Using the Plugin

When properly configured, the Candy web client will be made available on the same ports as the HTTP binding interface. The exact URLs for your instance of Openfire are displayed on the Candy Configuration Admin Console page. By default, these URLs are:

- `http://<your-server-name>:7070/candy/` (unencrypted HTTP)
- `https://<your-server-name>:7443/candy/` (encrypted HTTPS)

After opening one of these addresses in a browser, the user is presented with a login form. After logging in, the user will automatically join all of the configured auto-join rooms.