Openfire Installation

Openfire is an open-source, third-party instant messaging and groupchat server. It uses XMPP server
written in Java.

Prerequisites

l Application server
o 8 GB Ram
o 4 CPU
o Java Runtime Environment 64-bit
l Database server
o Microsoft SQL Server 2012
l Database Creation

o Create a new database using Enterprise manager.

Note: You may name the database as openfiredb.

o Create a user to access the database if a user is not already present.

Note: It is recommended to make the newly-created database as the default

database for this user.

The following image shows an example of a database.

Install Openfire

This section contains information about installing Openfire.

 To install Openfire:

1. Download openfire_4_1_1.exe.
2. Run the openfire_4_1_1.exe file and follow the steps in the installation wizard.

Setup Openfire

This section contains information about setting up Openfire after installation. Setting up Openfire is a
two-step process:

1. Configure Openfire
2. Configure Administrator Console

Configure Openfire
This section contains information about configuring Openfire.
To configure Openfire:

1. Open Openfire with administrator privileges.

A pop-up window is displayed as seen in the following image.

2. Click Launch Admin to open the Openfire setup page.

3. Choose a language and click Continue to open the Server Settings page.
4. Provide the XMPP Domain Name and Server Host Name (FQDN).

Note: The recommended naming convention for these two fields is

<hostname>.<DomainName>.

Note: It is recommended to retain the Admin Console Port, Secure Admin

Console Port, and Property Encryption via as is.

5. Click Continue to open the Database Settings page.

6. Select Standard Database Connection.
 7. Click Continue to open the Database Settings - Standard Connection page.
8. Specify the following information.

l Database Driver Presets: Select the database driver where the new database (Example:
openfiredb) is created (Microsoft SQL Server).
l Database URL: Enter the required information in the URL for [host-name] and
[database-name]

Note: Host-name is the server where the database is installed.

Database-name is the name of the database (Example: openfiredb).

l Username: Username of the user created during database creation. For more information
see, Prerequisites on page1.
l Password: Password of the user created during database creation. For more information see,
Prerequisites on page1.
l Minimum Connections: Enter a number as required.
l Maximum Connections: Enter a number as required.
l Connection Timeout: Enter a number as required.

9. Click Continue to open the Profile Settings page.

10. Select Default and click Continue to open the Admin Account page.
11. Specify the following information.

l Current Password

Note: For a new installation the default password is admin.

l Admin Email Address

l New Password
l Confirm Password

12. Click Continue.

The Setup Complete page appears.

Configure Administrator Console
The next step in setting up Openfire is to configure the Administrator Console. This section contains
the steps required to do this.
To configure the Administrator Console:

1. Open a browser and enter <IP Address of the application server>:9090 to open the
Administrator Console.
2. Login with the credentials created during Openfire setup.
3. Go to Server > Server Settings > Client Connections.

4. In the Idle Connections Policy section, select Do not disconnect clients that are idle.

5. Click Save Settings.

6. Go to Server > Server Manager> System Properties.
 7. Use the Add new Property Section to add Property Name and Property Value as mentioned
in the following table.

Property Name Property Value

sasl.mechs PLAIN

httpbind.CORS.domains TRUE

httpbind.CORS.enabled TRUE

httpbind.enabled TRUE

httpbind.forwarded.enabled TRUE

plugin.broadcast.allowedUsers TRUE

xmpp.httpbind.scriptSyntax.enabled TRUE

8. Go to Plugins > Plugin Admin > Available Plugins.

9. Locate the plugin and install it using the button.

10. Go to Server > Server Settings >Rest API.
11. Select Enabled - REST API requests will be processed.
12. Select Secret key auth - REST API authentication over specified secret key.

Note: You can either use the key generated by Openfire or update a separate key
generated by the organization.
 13. Click Save Settings.

The Openfire setup is now complete.

Upgrade to Java Runtime Environment 64-bit

The Java Runtime Environment (JRE) 32-bit version has low Java virtual memory and supports only
about 10,000 users. However, the JRE 64-bit version has higher Java virtual memory and has been
tested to support up to 45,000 users. Hence, it is recommended that you upgrade your JRE to the 64-
bit version.
Prerequisites
Openfire application must be closed.
To upgrade to JRE64-bit:

1. Go to the folder where Openfire is installed.

Example: C:\Program Files (x86)\Openfire

2. Rename the jre folder as jre32.

3. Download JRE 64-bit and place it in the folder where Openfire is installed.

Example: C:\Program Files (x86)\Openfire

4. Rename the folder containing JRE 64-bit as jre.

5. Go to Control Panel > System and Security > System > Advanced system settings.

The Systems Properties window opens.

 6. Click Environment Variables to open the Environment Variables window.
7. Select JAVA_HOME under the System variables section and click Edit to open the Edit
System Variable window.

8. Enter <OpenfireInstallationPath>\jre\bin in Variable Value and click OK.

9. Select Path under System Variables and click Edit.
10. Enter <OpenfireInstallationPath>\jre\bin in Variable Value and click OK.
11. Restart the system.
12. Open Command Prompt.
13. Change the directory <Openfire Installation Path>/lib
14. Run the command java jar startup.jar.
Openfire Logs

This section contains following information relating to Openfire logs on the server side.

l Enabling and disabling Openfire logs.

l Editing the location where the logs are saved.
l Editing the type of logs.

To edit Openfire logs

1. On the application server, go to C:\Program Files(x86)\SupportSoft\<Instance1>\bin.

2. Find and edit messagebroadcastlogs.config file.
3. To enable or disable Openfire logs, do one of the following in the root section as shown in the
following image.

l To enable all logs change the value of level value to ALL.

l To disable all logs change the value of level value to OFF.

4. To edit the location where the logs are saved, do the following.

a. Find File value tag under the required appender name.

b. Change the path to the required location.

Note: By default, the log files are saved at the following location: C:\logs\err_
warn.log.

5. To edit the type of logs:

a. In the root section, find the level value tag and change the value to the required value.

Note: The following options are available:

FATAL
ERROR
WARN
INFO
DEBUG
TRACE

6. Save and close the file.