Operfire Installation Guide

This article is from http://www.igniterealtime.org/builds/openfire/docs/latest/documentation/install-guide.html.

Installation Guide

Openfire is a powerful instant messaging (IM) and chat server that implements XMPP. This file will guide you through installing Openfire. For a complete list of more features and information, visit the Openfire Website: http://www.igniterealtime.org/projects/openfire/

Directory

• 1 Installation
  • 1.1 Windows
  • 1.2 Linux/Unix
• 2 installation overview
• 3 files in the distribution Edition
• 4. Install the database
• 5. Install the server
• 6 Management Console
• 7. Run Openfire in Windows
  • 7.1 Windows Services
  • 7.2 custom Parameters
• 8. Run Openfire in Linux/Unix
  • 8.1 custom Parameters
• 9 plug-ins
  • 9.1 install plug-ins
  • 9.2 Management plug-ins

Install Windows

Run the Openfire installation package. The application will be installed in the directory c: \ Program Files \ Openfire by default.

Linux/Unix

You can select an rpmpackage or a tar.gz package. If you use an RPM package, run your package manager to install it Openfire to the/opt/openfire directory:

rpm -ivh openfire_3_0_0.rpm

If you use the .tar.gz package, decompress it to the directory/opt or/usr/bin:

tar -xzvf openfire_3_0_0.tar.gzmv openfire /opt

Note:: .Tar.gz package does not necessarily contain Java Virtual Machine (JRE ). therefore, you must have JDK, JRE 1.5.0 (Java 5) or later installed in your system. you can type "java-version" in the command line to check your java version and then (if necessary) access the http://java.sun.com to update your Java installation.

Installation overview

To install Openfire, follow these steps:

1. Database-if you choose to use an external database, you must prepare your database for Openfire.
2. Install-install and verify the server configuration using a built-in web-based Installation tool.
3. Console-use a web-based management tool to manage servers.

This article also includes the following information:

• Run in Windows
• Run in Unix/Linux
• Install and use plug-ins

Files in the distribution Edition

The files in your distribution version should be as follows (to be brief, some subdirectories are ignored ):

openfire/ |- readme.html |- license.html |- conf/ |- bin/ |- jre/ |- lib/ |- plugins/     |- admin/ |- resources/     |-database/     |-security/ |- documentation/

• ConfThe Openfire directory is used to store configuration files.
• BinThe directory contains the executable files of the server. Depending on the distribution version you have installed, the available executable files are also different.
• JreThe directory contains a Java 5 virtual machine packaged in Openfire for Windows and RPM.
• LibThe directory contains the library required to run Openfire.
• PluginsThe directory contains the server plug-in. By default, Openfire comes with a web-based management console plug-in.
• Resources/databaseThe directory contains the SQL architecture file used to create an Openfire database and an installed update script.
• Resources/securityThe directory is where Openfire maintains keystores to support SSL connection security.
• DocumentationThe directory contains the server documentation.

Install Database

Openfire can store its data in an embedded database. You can also choose to use an external database, such as MySQL or Oracle. if you prefer to use an external database, you must prepare it before you start the installation. for more information, see database installation.

Install the server

Openfire provides a web-based, wizard-driven installation and configuration tool. start Openfire and use a browser to connect to the console. the default port of the web-based console is 9090. if you are on the same machine as Openfire, the following URL usually works: http: // 127.0.0.1: 9090.

Management Console

After completing the preceding steps, Openfire will be configured. You can use the web-based console to manage the server. the URL should be the same as the one you used to install the server, unless you modified the Port during installation.

Run Openfire in Windows

If you use the Openfire installation package, you can use a shortcut in the Start menu to start the graphical launcher. otherwise, run openfire.exe in the bin/directory of your Openfire installation location. there is a button on the startup interface that allows you to automatically open your web browser to connect to the correct URL to complete Server installation.

Windows Services

If you are running Openfire in Windows, you may want to run Openfire as a standard Windows after initialization and installation. if you use the Windows Installation Package, a openfire-service.exe file will appear in the bin directory under the installation directory. you can use this executable file to install and control the Openfire service.

In the console window, you can run the following command:

• Openfire-service/install-- Install the service.
• Openfire-service/uninstall-- Uninstall the service.
• Openfire-service/start-- Start the service.
• Openfire-service/stop-- Stop the service.

You can also use the service tool on the Windows Control Panel to start and stop the service.

Note: The graphic starter is currently not compatible with Windows Services. If you have installed the service, you should use the above service console to control the service rather than the graphic starter.

Custom Parameters

Advanced users may want to pass parameters to the Java Virtual Machine (VM) to customize the runtime environment of Openfire. you can create a vmoptions file in the bin/directory under your Openfire installation directory. for Windows Services, you need to create a new text file named openfire-service.vmoptions. each VM parameter should occupy one line in the file independently. for example, you can set the minimum stack size to 512 MB and the maximum VM stack to 1024 MB:

-Xms512m-Xmx1024m

To create a parameter for a common initiator, create a file named openfired. vmoptions (because the openfire.exe initiator calls the openfired.exe executable file to actually start the server ).

Run Openfire in Linux/Unix

If you are running (CentOS, Fedora, etc.) on a Red Hat or Red Hat-like system, we recommend that you use RPM, because it contains some standard custom processing like Red Hat environment. if you use RPM, you can use/Etc/init. d/openfireThe script starts and stops Openfire.

# /etc/init.d/openfireUsage /etc/init.d/openfire {start|stop|restart|status|condrestart|reload}# /etc/init.d/openfire startStarting openfire:

If you are running in a different Linux/Unix variant and/or you have used the tar.gz 'installation package ', you can use the bin/Openfire script in your openfire installation directory to start and stop Openfire:

# ./openfireUsage: ./openfire {start|stop}# ./openfire startStarting openfire

If you want to install Openfire as a service, two scripts are provided in the bin/extra directory:

• Redhat-postinstall.sh -- automatically installs Openfire as a Red Hat service. it creates a new "jive" user and copies the openfired script to your init. d directory. this script must be run as root. for more information, see the notes in the script.
• Openfired -- use Openfire as a service running script. You must manually configure this script. For more information, see the notes in the script.

If you install it through RPM, it is not recommended that you use these scripts. RPM has taken good care of these scripts.

Custom Parameters

You can create a vmoptions file in the bin/directory under your Openfire installation directory. for Windows Services, you need to create a new text file named openfire-service.vmoptions. each VM parameter should occupy one line in the file independently. for example, you can set the minimum stack size to 512 MB and the maximum VM stack to 1024 MB:

Advanced users may want to pass parameters to the Java Virtual Machine (VM) to customize the runtime environment of Openfire. if you installed it through RPM, You can edit the/etc/sysconfig/openfire file and find the OPENFIRE_OPTS option to customize it. if you have installed it through .tar.gz, you need to adjust your startup script to meet your needs.

Plug-ins

The plug-in adds additional features and protocol support to Openfire. after installing your Openfire, you may want to download and install the plug-in to enhance your server. the plugin can be downloaded from the plugins page of igniterealtime.org or directly from the internal console.

Install plug-ins

If you download a plug-in from the Openfire internal console, it will be automatically installed. if you manually download this plug-in (package it into one. jar file). You can copy the plug-in file to the plugins/directory under the Openfire installation directory to deploy it. A plug-in monitor automatically unpacks the plug-in to a directory and installs the plug-in to Openfire. you can also use the "Upload plug-in" function (on the plug-in tab) on the management console to load a plug-in from the local file system to the server.

Management plugin

Plug-ins can be managed through the internal Openfire console. you can also manually delete a plug-in by deleting the JAR file of the plug-in at any time (when you do this, Openfire will automatically remove the plug-in from the memory and delete its directory ).