Skip to content

O
Openfire
Commit 68243ed2 authored by Matt Tucker's avatar Matt Tucker Committed by matt
Browse files
Options

Doc updates 


git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@790 b35dd754-fafc-0310-a699-88a17e54d16e
parent 0dc753ca
Hide whitespace changes
Inline Side-by-side
Showing with 63 additions and 79 deletions
documentation/docs/database-guide.html
View file @ 68243ed2
...@@ -10,21 +10,16 @@ ...@@ -10,21 +10,16 @@
<h2>Introduction</h2> <h2>Introduction</h2>
<p> <p>
This document outlines the data type conventions and tables in the Jive This document outlines the data type conventions and tables in the Jive
Messenger 2.1 database Messenger 2.1 database schema. Some information, like column indexes and foreign keys, is
schema. Some information, like column indexes and foreign keys, is omitted. For this, please read the individual schema of the database you're interested in.
omitted. For this, please
read the individual schema of the database you're interested in.
<br> <br>
</p> </p>
<h2>Data Type Conventions</h2> <h2>Data Type Conventions</h2>
<p> <p>
Date column type support varies widely across databases. Therefore, Date column type support varies widely across databases. Therefore,
Jive Messenger Jive Messenger specially encodes dates as VARCHAR values. Each date is a Java long
specially encodes dates as VARCHAR values. Each date is a Java long value which is 0-padded to 15 characters. The long value is the internal
value which representation of Java Date objects, which can be obtained with code such as the
is 0-padded to 15 characters. The long value is the internal
representation of
Java Date objects, which can be obtained with code such as the
following: following:
</p> </p>
<pre>long currentDate = new Date().getTime();</pre> <pre>long currentDate = new Date().getTime();</pre>
......
documentation/docs/database.html
View file @ 68243ed2
...@@ -13,7 +13,7 @@ This document provides setup instructions for all of the currently supported dat ...@@ -13,7 +13,7 @@ This document provides setup instructions for all of the currently supported dat
<p> <p>
JDBC 2.0 drivers are required for Jive Messenger to communicate with your database. Suggested JDBC 2.0 drivers are required for Jive Messenger to communicate with your database. Suggested
drivers for particular databases are noted below where applicable. However, drivers for particular databases are noted below where applicable. However,
<em>the JDBC-ODBC bridge will not work with Jive under any circumstances</em>. <em>the JDBC-ODBC bridge will not work with Jive Messenger under any circumstances</em>.
</p> </p>
<p> <p>
For a full list of available JDBC drivers, please see: For a full list of available JDBC drivers, please see:
......
documentation/docs/install-guide.html
View file @ 68243ed2
...@@ -17,13 +17,15 @@ visit the Jive Messenger website: <a href="http://www.jivesoftware.org/messenger ...@@ -17,13 +17,15 @@ visit the Jive Messenger website: <a href="http://www.jivesoftware.org/messenger
<p>In order to install Jive Messenger, you'll need a server environment <p>In order to install Jive Messenger, you'll need a server environment
that meets the following requirements: </p> that meets the following requirements: </p>
<ul> <ul>
<li><b>JDK 1.5.0</b> (Java 5) or later. You can check your java version by typing "java <li><b>JDK 1.5.0</b> (Java 5) or later. Java 5 is bundled with the
-version" at the command line. See <a href="http://java.sun.com">http://java.sun.com</a> platform-specific Jive Messenger installers. If you are using the ".zip" or ".tar.gz"
for Java on your platform or download a Jive Messenger installer with distribution, you can check your java version by typing "java -version" at the
bundled JVM for your operating system.</li> command line and (if necessary) upgrade your Java installation by visiting
<li>A supported database with a robust JDBC 2.0 compliant driver. <a href="http://java.sun.com">http://java.sun.com</a>.</li>
Supported databases and recommended JDBC drivers are detailed in the <li>A supported database with a robust JDBC driver, or you can
database documentation below. Alternatively, you can use the embedded database.</li> choose to use the embedded database during the setup process. Supported
databases and recommended JDBC drivers are detailed in the database
documentation below.</li>
</ul> </ul>
<h2>Installation Overview</h2> <h2>Installation Overview</h2>
...@@ -34,7 +36,7 @@ perform each of the following steps: </p> ...@@ -34,7 +36,7 @@ perform each of the following steps: </p>
Messenger. </li> Messenger. </li>
<li><a href="#config">Setup</a> - Use the built in web based setup <li><a href="#config">Setup</a> - Use the built in web based setup
tool to setup and verify the server configuration.</li> tool to setup and verify the server configuration.</li>
<li><a href="#tools">Admin Tool</a> - use the web-based admin tool to <li><a href="#tools">Admin Console</a> - use the web-based admin tool to
manage the server.</li> manage the server.</li>
</ol> </ol>
<h2><a name="distribution">Files in the Distribution</a></h2> <h2><a name="distribution">Files in the Distribution</a></h2>
...@@ -56,10 +58,8 @@ sub-directories omitted for brevity): </p> ...@@ -56,10 +58,8 @@ sub-directories omitted for brevity): </p>
<ul> <ul>
<li>The <tt>conf</tt> directory is where Jive Messenger stores <li>The <tt>conf</tt> directory is where Jive Messenger stores
configuration files.</li> configuration files.</li>
<li>The <tt>bin</tt> directory contains the server executable scripts. <li>The <tt>bin</tt> directory contains the server executables. Depending
Run startup.bat or startup.ssh. If you used the Jive Messenger installer, on which distribution you installed, different executables will be available.</li>
native executables are also provided for your convenience. Below the base
directory are platform specific deployment tools for running Messenger as service, etc.</li>
<li>The <tt>lib</tt> directory contains libraries necessary for <li>The <tt>lib</tt> directory contains libraries necessary for
running Jive Messenger.</li> running Jive Messenger.</li>
<li>The <tt>plugins</tt> directory contains server plugins. By <li>The <tt>plugins</tt> directory contains server plugins. By
...@@ -73,15 +73,15 @@ maintains keystores to support SSL connection security.</li> ...@@ -73,15 +73,15 @@ maintains keystores to support SSL connection security.</li>
documentation.</li> documentation.</li>
</ul><p> </ul><p>
<h2><a name="database">Setting Up the Database</a></h2> <h2><a name="database">Setup the Database</a></h2>
<p> <a>Jive Messenger uses a database to store it's data. To setup <p> <a>Jive Messenger uses a database to store it's data. To setup
your your database you must load the appropriate database schema. You can find
database you must load the appropriate database schema. You can find
schemas in the <tt>resources/database</tt> directory of this distribution. View schemas in the <tt>resources/database</tt> directory of this distribution. View
the </a><a href="database.html">database the </a><a href="database.html">database
setup</a> documentation to learn how to install the schemas and JDBC setup</a> documentation to learn how to install the schemas and JDBC
drivers.</p> drivers. Alternatively, you can select the embedded database during
<p> Complete the database steps outlined in the database setup the setup process.</p>
<p>Complete the database steps outlined in the database setup
documentation before proceeding further.<br> documentation before proceeding further.<br>
</p> </p>
<h2><a name="config"></a>Setup the Server</h2> <h2><a name="config"></a>Setup the Server</h2>
...@@ -89,64 +89,53 @@ documentation before proceeding further.<br> ...@@ -89,64 +89,53 @@ documentation before proceeding further.<br>
into into
Jive Messenger. Simply launch Jive Messenger and use a web browser to Jive Messenger. Simply launch Jive Messenger and use a web browser to
connect to the admin console. The default port for the connect to the admin console. The default port for the
web-based admin console is 9090. If you are on the same machine as Messenger the web-based admin console is 9090. If you are on the same machine as Messenger, the
following URL will following URL will usually work:
usually work: <a href="http://127.0.0.1:9090">http://127.0.0.1:9090</a>.</p> <a href="http://127.0.0.1:9090">http://127.0.0.1:9090</a>.</p>
<p>If you used the Jive Messenger installer, a shortcut for starting the <p>If you used the Jive Messenger installer, a shortcut for starting the
application is provided. Starting the server using this icon starts a a graphical launcher is provided. A button on the on the launcher allows
graphical launcher application. A button you to automatically open your web browser to the correct URL to finish
on the launcher allows you to automatically open your web browser to setting up the server:
the correct URL
to finish setting up the server. Large deployments should use the
command line or Windows Service or *nix deployment options described
below to properly configure JVM settings before using. If you didn't
use the installer, you can start Jive Messenger using the startup script
in the <tt>bin</tt> directory.
<p>If you want to manually set up the server, edit the <tt>conf/jive-messenger.xml</tt>
file. To bypass the server's normal setup mode after manually
configuring the server, add
a &lt;setup&gt;true&lt;/setup&gt; element to the XML file to indicate
that the server
has been setup.</p>
<p> <p>
If you wish to use SSL, run the keytool application that ships with the <div align="center">
Sun JDK to add the appropriate server certificates to the keystore <img src="images/launcher.png" alt="Jive Messenger Launcher" width="323" height="277" align="center">
located in the <tt>security</tt> directory. Self-signed certificates </div>
will work fine for testing. We've provided a dummy self-signed </p>
certificate for your server if it is 127.0.0.1 (the localhost).</p>
<!--
<h3>Windows Service</h3> <h3>Windows Service</h3>
<p>If you're running Messenger on Windows, you will eventually want to <p>If you're running Messenger on Windows, you will likely want to
run Messenger as a standard Windows service. run Messenger as a standard Windows service after initial setup.
In order to do this, make sure the <tt>JAVA_HOME</tt> environmental If you used the Windows installer, a <tt>messenger-service.exe</tt> file
variable is set to the base directory of your JRE/JDK directory or the <tt>jre</tt> will be in the <tt>bin</tt> directory of the installation. You can use
sub directory of your installation if you this executable to install and control the Jive Messenger service.
installed a built-in JRE (Control Panel, System, Advanced, click on the
"Enviromental Variables" button). Next, copy all the files
from the <tt>bin/windows</tt> to the <tt>bin</tt> directory. Edit the
<tt>config/wrapper.conf</tt> file to allocate the proper amount of heap
memory
for your deployment. On most systems, Messenger will need about 256MB
of heap memory for each 1000 simultaneous connections (<a href="note1">1</a>).<br>
</p> </p>
<p>Run <tt>install-messengerd.bat</tt> to install Messenger as a From a console window, you can run the following commands:
windows service. <ul>
Now you can use the Control Panel, Administration Tools, Services <li><tt>messenger-service /install</tt> -- installs the service.
applet to start, stop, and restart Messenger as well as determine if it <li><tt>messenger-service /uninstall</tt> -- uninstalls the service.
starts with the server, what happens on failures, etc. Uninstall the <li><tt>messenger-service /start</tt> -- starts the service
Messenger windows service by running <li><tt>messenger-service /stop</tt> -- stops the service.
<tt>uninstall-messenger.bat</tt>.</p> </ul>
<p>You can also run Messenger directly using the included <tt>messengerd.bat</tt>
script using the same <p>
service wrapper code that the Windows service uses. The service wrapper <div align="center">
provides quality of service tools that <img src="images/windows_service.png" alt="Windows Service" width="557" height="223" align="center">
ensure high reliability operation of Messenger including detecting hung </div>
or failed processes and automatically </p>
restarting Messenger.</p>
<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
as described above to control the server rather than the graphical launcher.</p>
<!--
<h3>Solaris/Linux/MacOS X Deployment</h3> <h3>Solaris/Linux/MacOS X Deployment</h3>
<p>If you are deploying Messenger on these three supported Unix <p>If you are deploying Messenger on these three supported Unix
systems, platform specific startup scripts and helper systems, platform specific startup scripts and helper
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023