install-guide.html 9.04 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>Jive Software Messenger Readme</title>
  <link href="style.css" rel="stylesheet" type="text/css">
</head>
<body>
<h1>Jive Messenger Installation Guide</h1>

<p>Jive Messenger is a powerful instant messaging (IM) and chat
server that implements the XMPP protocol. This document will guide 
you through installing Jive Messenger as a standalone
application. For a full list of features and more information, please
visit the Jive Messenger website: <a href="http://www.jivesoftware.org/messenger"
 target="_top">http://www.jivesoftware.org/messenger</a></p>

Matt Tucker's avatar
Matt Tucker committed
17
<h2>Installation</h2>
Matt Tucker's avatar
Matt Tucker committed
18
<ul>
Matt Tucker's avatar
Matt Tucker committed
19 20 21 22 23
<h3>Windows</h3>
Run the Jive Messenger installer. The application will be installed to <tt>c:\Program Files\Jive Messenger</tt> by default.
 
 <h3>Linux/Unix</h3>
 
Matt Tucker's avatar
Matt Tucker committed
24 25
 Choose either the RPM or tar.gz build. If using the RPM, run it using your package manager to install Jive Messenger to <tt>/opt/jive_messenger</tt>:

Matt Tucker's avatar
Matt Tucker committed
26
 <p><tt>rpm -ivh jive_messenger_2_1_2.rpm</tt></p>
Matt Tucker's avatar
Matt Tucker committed
27 28
 
 If using the .tar.gz, extract the archive to <tt>/opt</tt> or <tt>/usr/bin</tt>:
Matt Tucker's avatar
Matt Tucker committed
29

Matt Tucker's avatar
Matt Tucker committed
30
 <p><tt>tar -xzvf jive_messenger_2_1_2.tar.gz<br>
Matt Tucker's avatar
Matt Tucker committed
31 32
 mv jive_messenger /opt</tt></p>

Matt Tucker's avatar
Matt Tucker committed
33
 <p><b>Note:</b> the .tar.gz build does not contain a bundled Java runtime (JRE). Therefore, you must have JDK or JRE 1.5.0 (Java 5) or later installed on your system. You can check your java version by typing "java -version" at the command line and (if necessary) upgrade your Java installation by visiting http://java.sun.com.</p>
Matt Tucker's avatar
Matt Tucker committed
34

Matt Tucker's avatar
Matt Tucker committed
35
  </ul>
Matt Tucker's avatar
Matt Tucker committed
36
<h2>Setup Overview</h2>
Matt Tucker's avatar
Matt Tucker committed
37 38 39
<p>To complete the installation of Jive Messenger, you'll need to
perform each of the following steps: </p>
<ol>
Matt Tucker's avatar
Matt Tucker committed
40 41
  <li><a href="#database">Database</a> - if you choose to use an external database, you must
 prepare your database for Jive Messenger. </li>
Matt Tucker's avatar
Matt Tucker committed
42
  <li><a href="#config">Setup</a> - Use the built-in web-based setup
Matt Tucker's avatar
Matt Tucker committed
43
tool to setup and verify the server configuration.</li>
Matt Tucker's avatar
Matt Tucker committed
44
  <li><a href="#tools">Admin Console</a> - use the web-based admin tool to
Matt Tucker's avatar
Matt Tucker committed
45 46
manage the server.</li>
</ol>
Matt Tucker's avatar
Matt Tucker committed
47 48 49 50 51 52

<p>This document also includes information on:</p>

<ul>
    <li><a href="#windows">Running under Windows</a>
    <li><a href="#unix">Running under Unix/Linux</a>
Matt Tucker's avatar
Matt Tucker committed
53
    <li><a href="#plugins">Installing and using plugins</a>
Matt Tucker's avatar
Matt Tucker committed
54 55
</ul>

Matt Tucker's avatar
Matt Tucker committed
56 57 58 59 60 61 62 63
<h2><a name="distribution">Files in the Distribution</a></h2>
<p> The files in your distribution should be as follows (some
sub-directories omitted for brevity): </p>
<pre>jive_messenger/  
 |- readme.html
 |- license.html
 |- conf/
 |- bin/
Matt Tucker's avatar
Matt Tucker committed
64
 |- jre/
Matt Tucker's avatar
Matt Tucker committed
65 66 67 68 69 70 71 72 73 74 75
 |- lib/
 |- plugins/
     |- admin/
 |- resources/
     |-database/
     |-security/
 |- documentation/</pre>

<ul> 
	 <li>The <tt>conf</tt> directory is where Jive Messenger stores
configuration files.</li>
Matt Tucker's avatar
Matt Tucker committed
76 77
  <li>The <tt>bin</tt> directory contains the server executables. Depending
on which distribution you installed, different executables will be available.</li>
Matt Tucker's avatar
Matt Tucker committed
78
  <li>The <tt>jre</tt> directory contains a Java 5 runtime that is bundled with the Windows and RPM versions of Jive Messenger.</li>
Matt Tucker's avatar
Matt Tucker committed
79 80 81 82 83 84 85 86 87 88 89 90 91
  <li>The <tt>lib</tt> directory contains libraries necessary for
running Jive Messenger.</li>
  <li>The <tt>plugins</tt> directory contains server plugins. By
default, Jive Messenger ships with a web-based admin console plugin.</li>
  <li>The <tt>resources/database</tt> directory contains SQL schema files to
create new Jive Messenger databases, as well as upgrade scripts for
existing installations. </li>
  <li>The <tt>resources/security</tt> directory is where Jive Messenger
maintains keystores to support SSL connection security.</li>
  <li>The <tt>documentation</tt> directory contains server
documentation.</li>
</ul><p>

Matt Tucker's avatar
Matt Tucker committed
92
<h2><a name="database">Setup the Database</a></h2>
Matt Tucker's avatar
Matt Tucker committed
93
<p> <a>Jive Messenger can store its data in an embedded database or you can choose to use
Matt Tucker's avatar
Matt Tucker committed
94
an external database such as MySQL or Oracle. If you would like to use an external database,
Matt Tucker's avatar
Matt Tucker committed
95 96 97 98
you must prepare it before proceeding with installation by running the appropriate database
schema. View the </a><a href="database.html">database
setup</a> documentation for more information.</p>

Matt Tucker's avatar
Matt Tucker committed
99 100
</p>
<h2><a name="config"></a>Setup the Server</h2>
Matt Tucker's avatar
Matt Tucker committed
101
<p>A web-based, "wizard" driven setup and configuration tool is built
Matt Tucker's avatar
Matt Tucker committed
102
into Jive Messenger. Simply launch Jive Messenger (platform-specific instructions below) and use a web browser to
Matt Tucker's avatar
Matt Tucker committed
103
connect to the admin console. The default port for the
Matt Tucker's avatar
Matt Tucker committed
104 105 106 107
web-based admin console is 9090. If you are on the same machine as Messenger, the
following URL will usually work: 
<a href="http://127.0.0.1:9090">http://127.0.0.1:9090</a>.</p>

Matt Tucker's avatar
Matt Tucker committed
108 109 110 111 112 113 114 115 116
<h2><a name="tools">Admin Console</a></h2>
<p>After completing the above steps, Messenger will be configured
and you can use the web-based admin console to administer
the server. The URL should be the same as you used to setup the server
unless you changed the port during the setup.<br>
</p>

<hr>

Matt Tucker's avatar
Matt Tucker committed
117
<h2><a name="windows">Running Jive Messenger in Windows</a></h2>
Matt Tucker's avatar
Matt Tucker committed
118

Matt Tucker's avatar
Matt Tucker committed
119
<p>If you used the Jive Messenger installer, a shortcut for starting the
Matt Tucker's avatar
Matt Tucker committed
120 121
a graphical launcher is provided in your Start Menu. Otherwise, run messenger.exe in the <tt>bin/</tt> directory of your
Jive Messenger installation. A button on the on the launcher allows 
Matt Tucker's avatar
Matt Tucker committed
122 123
you to automatically open your web browser to the correct URL to finish 
setting up the server: 
Matt Tucker's avatar
Matt Tucker committed
124 125

<p>
Matt Tucker's avatar
Matt Tucker committed
126 127 128 129
<div align="center">
<img src="images/launcher.png" alt="Jive Messenger Launcher" width="323" height="277" align="center">
</div>
</p>
Matt Tucker's avatar
Matt Tucker committed
130 131

<h3>Windows Service</h3>
Matt Tucker's avatar
Matt Tucker committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
<p>If you're running Messenger on Windows, you will likely want to
run Messenger as a standard Windows service after initial setup.
If you used the Windows installer, a <tt>messenger-service.exe</tt> file
will be in the <tt>bin</tt> directory of the installation. You can use
this executable to install and control the Jive Messenger service.
</p>

From a console window, you can run the following commands:
<ul>
		<li><tt>messenger-service /install</tt> -- installs the service.
		<li><tt>messenger-service /uninstall</tt> -- uninstalls the service.
		<li><tt>messenger-service /start</tt> -- starts the service
		<li><tt>messenger-service /stop</tt> -- stops the service.
</ul>

<p>
<div align="center">
<img src="images/windows_service.png" alt="Windows Service" width="557" height="223" align="center">
</div>
Matt Tucker's avatar
Matt Tucker committed
151 152
</p>

Matt Tucker's avatar
Matt Tucker committed
153 154 155 156 157
<p>You can also use the Services tool in the Windows Control Panel to start and
stop the service.</p>

<p>Note: the graphical launcher is not compatible with the Windows service
at this time. If you install the service, you should use service controls
158 159 160 161 162 163 164 165 166
as described above to control the server rather than the graphical launcher.</p>

<h3>Custom Parameters</h3>

<p>Advanced users may wish to pass in parameters to the Java virtual machine (VM) to customize the runtime environment of Jive Messenger. You can do this by creating vmoptions files in the bin/ directory of your Jive Messenger installation. For the Windows service, you'd create a new text file called messenger-service.exe.vmoptions. Each parameter to the VM should be on a new line of the file. For example, to set the minimum and max VM heap size to 256 MB, you'd use:

<pre>-Xms256m
-Xmx256m</pre>

Matt Tucker's avatar
Matt Tucker committed
167
To create parameters for the normal launcher, create a file called messengerd.exe.vmoptions (since the messenger.exe launcher invokes the messengerd.exe executable to actually start the server).</p>
Matt Tucker's avatar
Matt Tucker committed
168

Matt Tucker's avatar
Matt Tucker committed
169
<h2><a name="unix">Running Jive Messenger in Linux/Unix</a></h2>
Matt Tucker's avatar
Matt Tucker committed
170 171 172 173 174 175 176 177 178 179 180

You can start and stop Jive Messenger using the <tt>bin/messenger</tt> script in your Jive messenger installation:

<p>
<tt>
# ./messenger<br>
Usage: ./messenger {start|stop}<br>
# ./messenger start<br>
Starting messenger
</tt></p>

Matt Tucker's avatar
Matt Tucker committed
181
If you would like to install Jive Messenger as a service, two scripts are provided in the <tt>bin/extra</tt>
Matt Tucker's avatar
Matt Tucker committed
182 183 184 185 186
directory:
<ul>
    <li>redhat-postinstall.sh -- automatically installs Jive Messenger as a service on Red Hat. It does so by creating a "jive" user and then copying the jive-messengerd script to your init.d directory. This script must be run as root. Please see the comments in the script for additional information.</li>
    <li>jive-messengerd -- script to run Jive Messenger as a service. You must manually configure this script. See the comments in
the script for additional details.</li>
Matt Tucker's avatar
Matt Tucker committed
187
</ul>
Matt Tucker's avatar
Matt Tucker committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207

<h2><a name="plugins">Plugins</a></h2>

Plugins add additional features and protocol support to Jive Messenger. After setting up your
Jive Messenger installation, you may want to download and install plugins to enhance your
server. Plugins can be downloaded from the
<a href="http://www.jivesoftware.org/messenger/plugins.jsp">plugins page</a> on jivesoftware.org.

<h3>Installing Plugins</h3>

Each plugin comes packaged as a .jar (JAR) file. After download the plugin, you can deploy it
by copying the plugin file to the <tt>plugins/</tt> directory of your Jive Messenger installation. A
plugin monitor will automatically extract the plugin into a directory and install the plugin in Jive Messenger.


<h3>Managing Plugins</h3>

Plugins can be managed inside the Jive Messenger admin console. You can also manually delete a plugin at any time by 
deleting its JAR file (Jive Messenger will automatically remove the plugin from memory and delete it's directory when you
do so).
Matt Tucker's avatar
Matt Tucker committed
208 209 210

</body>
</html>