Skip to content

O
Openfire
Commit a61ed402 authored by Ryan Graham's avatar Ryan Graham Committed by ryan
Browse files
Options

added new page design to the documenation, converted any instance of '2.6.x'... 

added new page design to the documenation, converted any instance of '2.6.x' in the text to '3.0.0' (only occurred on the installation guide page).

git-svn-id: http://svn.igniterealtime.org/svn/repos/wildfire/trunk@4167 b35dd754-fafc-0310-a699-88a17e54d16e
parent 01b8adf5
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 750 additions and 237 deletions
documentation/docs/database-guide.html
View file @ a61ed402
This diff is collapsed.
documentation/docs/database.html
View file @ a61ed402
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Wildfire Database Documentation</title>
<link href="style.css" rel="stylesheet" type="text/css">
<title>Jive Software - Wildfire: Database Installation Guide</title>
<link href="style.css" rel="stylesheet" type="text/css">
</head>
<body>
<h1><a name="introduction">Wildfire Database Setup</a></h1>
<div id="pageContainer">
<a name="top"></a>
<div id="pageHeader">
<div id="logo"></div>
<h1>Database Installation Guide</h1>
</div>
<div class="navigation">
<a href="index.html">&laquo; Back to documentation index</a>
</div>
<div id="pageBody">
<p>Wildfire stores all data in a back-end database. If you choose to not use the embedded
database, you must setup and manage an external database for the application.
......@@ -310,5 +324,9 @@ Choose your database from the list below for setup details:
</ol>
</ul>
</div>
</div>
</body>
</html>
documentation/docs/index.html
View file @ a61ed402
......@@ -2,13 +2,21 @@
<html>
<head>
<title>Wildfire: Overview - Jive Software</title>
<link type="text/css" rel="stylesheet" href="style.css">
<title>Jive Software - Wildfire: Overview</title>
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<body>
<h1>Wildfire @version@</h1>
<div id="pageContainer">
<div id="pageHeader">
<div id="logo"></div>
<h1>Wildfire @version@</h1>
</div>
<div class="navigation">
</div>
<div id="pageBody">
<p>
Wildfire provides comprehensive group chat and instant
......@@ -65,10 +73,16 @@ messaging (IM) services using the XMPP protocol.
</li>
</ul>
<br>
<p>
An active support community for Wildfire is available at
<a href="http://www.jivesoftware.org/forums/">http://www.jivesoftware.org/forums/</a>.
</p>
</div>
</div>
</body>
</html>
documentation/docs/install-guide.html
View file @ a61ed402
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Jive Software Wildfire Readme</title>
<link href="style.css" rel="stylesheet" type="text/css">
<title>Jive Software - Wildfire: Installation Guide</title>
<link href="style.css" rel="stylesheet" type="text/css">
</head>
<body>
<h1>Wildfire Installation Guide</h1>
<div id="pageContainer">
<a name="top"></a>
<div id="pageHeader">
<div id="logo"></div>
<h1>Installation Guide</h1>
</div>
<div class="navigation">
<a href="index.html">&laquo; Back to documentation index</a>
</div>
<div id="pageBody">
<p>Wildfire is a powerful instant messaging (IM) and chat
server that implements the XMPP protocol. This document will guide
......@@ -23,11 +37,12 @@ Run the Wildfire installer. The application will be installed to <tt>c:\Program
Choose either the RPM or tar.gz build. If using the RPM, run it using your package manager to install Wildfire to <tt>/opt/wildfire</tt>:
<p><tt>rpm -ivh wildfire_2_4_0.rpm</tt></p>
<p><tt>rpm -ivh wildfire_3_0_0.rpm</tt></p>
If using the .tar.gz, extract the archive to <tt>/opt</tt> or <tt>/usr/bin</tt>:
<p><tt>tar -xzvf wildfire_2_4_0.tar.gz<br>
<p><tt>tar -xzvf wildfire_3_0_0.tar.gz<br>
mv wildfire /opt</tt></p>
<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>
......@@ -41,6 +56,7 @@ perform each of the following steps: </p>
prepare your database for Wildfire. </li>
<li><a href="#config">Setup</a> - Use the built-in web-based setup
tool to setup and verify the server configuration.</li>
<li><a href="#tools">Admin Console</a> - use the web-based admin tool to
manage the server.</li>
</ol>
......@@ -50,6 +66,7 @@ manage the server.</li>
<ul>
<li><a href="#windows">Running under Windows</a>
<li><a href="#unix">Running under Unix/Linux</a>
<li><a href="#plugins">Installing and using plugins</a>
</ul>
......@@ -73,11 +90,13 @@ sub-directories omitted for brevity): </p>
<ul>
<li>The <tt>conf</tt> directory is where Wildfire stores
configuration files.</li>
<li>The <tt>bin</tt> directory contains the server executables. Depending
on which distribution you installed, different executables will be available.</li>
<li>The <tt>jre</tt> directory contains a Java 5 runtime that is bundled with the Windows and RPM versions of Wildfire.</li>
<li>The <tt>lib</tt> directory contains libraries necessary for
running Wildfire.</li>
<li>The <tt>plugins</tt> directory contains server plugins. By
default, Wildfire ships with a web-based admin console plugin.</li>
<li>The <tt>resources/database</tt> directory contains SQL schema files to
......@@ -85,6 +104,7 @@ create new Wildfire databases, as well as upgrade scripts for
existing installations. </li>
<li>The <tt>resources/security</tt> directory is where Wildfire
maintains keystores to support SSL connection security.</li>
<li>The <tt>documentation</tt> directory contains server
documentation.</li>
</ul><p>
......@@ -134,6 +154,7 @@ run Wildfire as a standard Windows service after initial setup.
If you used the Windows installer, a <tt>wildfire-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 Wildfire service.
</p>
From a console window, you can run the following commands:
......@@ -142,6 +163,7 @@ From a console window, you can run the following commands:
<li><tt>wildfire-service /uninstall</tt> -- uninstalls the service.
<li><tt>wildfire-service /start</tt> -- starts the service
<li><tt>wildfire-service /stop</tt> -- stops the service.
</ul>
<p>
......@@ -178,6 +200,7 @@ You can start and stop Wildfire using the <tt>bin/wildfire</tt> script in your W
<p>
<tt>
# ./wildfire<br>
Usage: ./wildfire {start|stop}<br>
# ./wildfire start<br>
Starting wildfire
......@@ -189,6 +212,7 @@ directory:
<li>redhat-postinstall.sh -- automatically installs Wildfire as a service on Red Hat. It does so by creating a "jive" user and then copying the wildfired 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>wildfired -- script to run Wildfire as a service. You must manually configure this script. See the comments in
the script for additional details.</li>
</ul>
<h2><a name="plugins">Plugins</a></h2>
......@@ -211,5 +235,9 @@ Plugins can be managed inside the Wildfire admin console. You can also manually
deleting its JAR file (Wildfire will automatically remove the plugin from memory and delete it's directory when you
do so).
</div>
</div>
</body>
</html>
documentation/docs/ldap-guide.html
View file @ a61ed402
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Wildfire LDAP Guide</title>
<link href="style.css" rel="stylesheet" type="text/css">
<title>Jive Software - Wildfire: LDAP Guide</title>
<link href="style.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="pageContainer">
<a name="top"></a>
<h1>Wildfire LDAP Guide</h1>
<div id="pageHeader">
<div id="logo"></div>
<h1>LDAP Guide</h1>
</div>
<div class="navigation">
<a href="index.html">&laquo; Back to documentation index</a>
</div>
<div id="pageBody">
<h2>Introduction</h2>
......@@ -31,6 +42,7 @@
such as <a href="http://www.openldap.org/">Open LDAP</a>,
<a href="http://www.microsoft.com/windowsserver2003/technologies/directory/activedirectory/">Active Directory</a>,
and Novell's <a href="http://www.novell.com/products/edirectory/">eDirectory</a>.
</p>
<p>
......@@ -57,6 +69,7 @@
<p>
In order to configure your server to use LDAP:
<ol>
<li>
Stop Wildfire.
</li>
......@@ -67,6 +80,7 @@
Restart Wildfire.
</li>
</ol>
</p>
<h3>Editing the Config File</h3>
......@@ -79,6 +93,7 @@
must be set. Properties flagged with (<font color="red"><b>**</b></font>) must be set in order
to enable LDAP group
support, all other properties are optional:
</p>
<ul>
<b>Main Settings</b><br><br>
......@@ -87,6 +102,7 @@
"org.jivesoftware.wildfire.ldap.LdapUserProvider".</li>
<li>provider.auth.className <font color="red"><b>*</b></font> -- set the value to
"org.jivesoftware.wildfire.ldap.LdapAuthProvider".</li>
<li>ldap.host <font color="red"><b>*</b></font> -- LDAP server host; e.g. localhost or
machine.example.com, etc. It is possible to use many LDAP servers but all of them
<b>should share the same configuration</b> (e.g. SSL, baseDN, admin account, etc).
......@@ -97,6 +113,7 @@
will performed with.
The entire subtree under the base DN will be searched for user accounts.
</li>
<li>ldap.alternateBaseDN -- a second DN in the directory can optionally be set. If set, the
alternate base DN
will be used for authentication and loading single users, but will not be used to display a
......@@ -117,6 +134,7 @@
<li>ldap.nameField -- the field name that holds the user's name. If this property is not
set, the default value is <tt>cn</tt>. Active Directory users should use the default value
<tt>displayName</tt>.</li>
<li>ldap.emailField -- the field name that holds the user's email address. If this property
is not set, the default value is <tt>mail</tt>. Active Directory users should use the
the default value <tt>mail</tt>.</li>
......@@ -130,10 +148,6 @@
<li>ldap.searchFilter -- the search filter that should be used when loading users. If this
property is not set, the default search will be for users that have the attribute specified by
ldap.usernameField.
<li>ldap.subTreeSearch -- the value "true" if the entire sub-tree under the base DN should
be included when executing searches (recursive search). If the value "false" is set, only
the first level under the base DN will be searched. The default value is "true", which is the better
option for the majority of directory layouts. Only set the value to "false" if necessary.</li>
<br><br>
<b>Group Settings</b><br><br>
......@@ -144,6 +158,7 @@
lookups will be performed on. If this property is not set, the default value is <tt>cn</tt>.</li>
<li>ldap.groupMemberField -- the field name that holds the members in a group. If this property
is not set, the default value is <tt>member</tt>.</li>
<li>ldap.groupDescriptionField -- the field name that holds the description a group. If this
property is not set, the default value is <tt>description</tt>.</li>
<li>ldap.posixMode <font color="red"><b>**</b></font> -- a value of "true" means that users are stored within the group by their
......@@ -151,6 +166,7 @@
the group. If this property is not set, the default value is <tt>false</tt>. <b>Note:</b>
the posix mode must be set correctly for your server in order for group integration to
work.</li>
<li>ldap.groupSearchFilter -- the search filter that should be used when loading groups. If this
property is not set, the default value is <tt>("ldap.groupNameField"={0})</tt>.</li>
......@@ -164,6 +180,7 @@
you
enable SSL connections, the LDAP server port number most likely should be changed to
636.</li>
<li>ldap.initialContextFactory -- the name of the class that should be used as an initial
context
factory. if this value is not specified, "com.sun.jndi.ldap.LdapCtxFactory" will be used
......@@ -183,33 +200,38 @@
<p>
Below is a sample config file section:
</p>
<pre><code>
<pre>
&lt;jive&gt;
...
&lt;ldap&gt;
&lt;host&gt;&lt;/host&gt;
&lt;port>389&lt;/port&gt;
&lt;usernameField&gt;uid&lt;/usernameField&gt;
&lt;nameField&gt;cn&lt;/nameField&gt;
&lt;emailField&gt;mail&lt;/emailField&gt;
&lt;baseDN&gt;ou=People;dc=example;dc=com&lt;/baseDN&gt;
&lt;adminDN&gt;cn=Directory Administrator&lt;/adminDN&gt;
&lt;adminPassword&gt;&lt;/adminPassword&gt;
&lt;/ldap&gt;
&lt;provider&gt;
&lt;user&gt;
&lt;className&gt;org.jivesoftware.wildfire.ldap.LdapUserProvider&lt;/className&gt;
&lt;/user&gt;
&lt;auth&gt;
&lt;className&gt;org.jivesoftware.wildfire.ldap.LdapAuthProvider&lt;/className&gt;
&lt;/auth&gt;
&lt;group&gt;
&lt;className&gt;org.jivesoftware.wildfire.ldap.LdapGroupProvider&lt;/className&gt;
&lt;/group&gt;
&lt;/provider&gt;
...
&lt;/jive&gt;
</code></pre>
</pre>
<p>You'll most likely want to change which usernames are authorized to login to the
admin console. By default, only the user with username "admin" is allowed to login. However,
......@@ -217,16 +239,17 @@
list of authorized usernames is controlled via the <tt>admin.authorizedUsernames</tt>
property. For example, to let the usersnames "joe" and "jane" login to the admin console:</p>
<pre><code>
<pre>
&lt;jive&gt;
...
&lt;admin&gt;
...
&lt;authorizedUsernames&gt;joe, jane&lt;/authorizedUsernames&gt;
&lt;/admin&gt;
...
&lt;/jive&gt;
</code></pre>
</pre>
<p><a name=""><h2>Custom Search Filter</h2></a></p>
......@@ -256,6 +279,7 @@
<p><a name="ctxFactory"><h2>Custom Inital Context Factory</h2></a></p>
<p>
Some LDAP servers or application servers may require that a different LDAP
initial context factory be used rather than the default (com.sun.jndi.ldap.LdapCtxFactory).
You can set a custom initial context factory by adding the following to wildfire.xml:
......@@ -278,6 +302,7 @@
<pre>&lt;ldap&gt;
... other ldap settings here
&lt;connectionPoolEnabled&gt;false&lt;/connectionPoolEnabled&gt;
&lt;/ldap&gt;</pre></p>
<p>
......@@ -304,6 +329,7 @@ clients that support the XMPP vCard extension. First, enable the provider:</p>
<pre>
&lt;provider&gt;
...
&lt;vcard&gt;
&lt;className&gt;org.jivesoftware.wildfire.ldap.LdapVCardProvider&lt;/className&gt;
......@@ -327,39 +353,47 @@ clients that support the XMPP vCard extension. First, enable the provider:</p>
<pre>
&lt;ldap&gt;
&lt;vcard-mapping&gt;
&lt;![CDATA[
&lt;vCard xmlns='vcard-temp'&gt;
&lt;FN attrs=&quot;displayName&quot;&gt;{0}&lt;/FN&gt;
&lt;NICKNAME attrs=&quot;uid&quot;&gt;{0}&lt;/NICKNAME&gt;
&lt;BDAY attrs=&quot;dob&quot;&gt;{0}&lt;/BDAY&gt;
&lt;ADR&gt;
&lt;HOME/&gt;
&lt;EXTADR&gt;Ste 500&lt;/EXTADR&gt;
&lt;STREET&gt;317 SW Alder St&lt;/STREET&gt;
&lt;LOCALITY&gt;Portland&lt;/LOCALITY&gt;
&lt;REGION&gt;Oregon&lt;/REGION&gt;
&lt;PCODE&gt;97204&lt;/PCODE&gt;
&lt;CTRY&gt;USA&lt;/CTRY&gt;
&lt;/ADR&gt;
&lt;TEL&gt;
&lt;HOME/&gt;
&lt;VOICE/&gt;
&lt;NUMBER attrs=&quot;telephoneNumber&quot;&gt;{0}&lt;/NUMBER&gt;
&lt;/TEL&gt;
&lt;EMAIL&gt;
&lt;INTERNET/&gt;
&lt;USERID attrs=&quot;mail&quot;&gt;{0}&lt;/USERID&gt;
&lt;/EMAIL&gt;
&lt;TITLE attrs=&quot;title&quot;&gt;{0}&lt;/TITLE&gt;
&lt;ROLE attrs=&quot;&quot;&gt;{0}&lt;/ROLE&gt;
&lt;ORG&gt;
&lt;ORGNAME attrs=&quot;o&quot;&gt;{0}&lt;/ORGNAME&gt;
&lt;ORGUNIT attrs=&quot;&quot;&gt;{0}&lt;/ORGUNIT&gt;
&lt;/ORG&gt;
&lt;URL attrs=&quot;labeledURI&quot;&gt;{0}&lt;/URL&gt;
&lt;DESC attrs=&quot;uidNumber,homeDirectory,loginShell&quot;&gt;
uid: {0} home: {1} shell: {2}
&lt;/DESC&gt;
&lt;/vCard&gt;
]]&gt;
&lt;/vcard-mapping&gt;
......@@ -393,10 +427,15 @@ clients that support the XMPP vCard extension. First, enable the provider:</p>
</ol>
You can also enable debugging to get more information from the LDAP module. To
do this, add &lt;log&gt;&lt;debug&gt;&lt;enabled&gt;true&lt;/enabled&gt;&lt;/debug&gt;&lt;/log&gt;
to your <tt>conf/wildfire.xml</tt> file. Log statements will be written
to the <tt>logs/debug.log</tt> file.
</ul>
</div>
</div>
</body>
</html>
\ No newline at end of file
documentation/docs/plugin-dev-guide.html
View file @ a61ed402
This diff is collapsed.
documentation/docs/protocol-support.html
View file @ a61ed402
......@@ -2,21 +2,26 @@
<html>
<head>
<title>Wildfire Protocol Support</title>
<link href="style.css" rel="stylesheet" type="text/css">
<style type="text/css">
.supported { background-color:#D0FFCB }
.partially_supported { background-color:#FEFF94 }
.unsupported { background-color:#FFB4B4 }
</style>
<title>Jive Software - Wildfire: Protocol Support</title>
<link href="style.css" rel="stylesheet" type="text/css">
</head>
<body>
<h1>Wildfire Protocol Support</h1>
<div id="pageContainer">
<a name="top"></a>
<div id="pageHeader">
<div id="logo"></div>
<h1>Protocol Support</h1>
</div>
<div class="navigation">
<a href="index.html">&laquo; Back to documentation index</a>
</div>
<div id="pageBody">
<p>Wildfire provides full support for the
<acronym title="Extensible Messaging and Presence Protocol">XMPP</acronym>
protocol defined by <a href="http://www.xmpp.org/specs/rfc3920.html">RFC 3920</a> and
......@@ -49,6 +54,7 @@ Suite</a>.</p>
<table class="dbtable">
<tr>
<th>Specification</th>
<th width="35%">Supported</th>
</tr><tr>
<td><a href="http://www.xmpp.org/specs/rfc3920.html">RFC 3920</a>: XMPP Core</td>
......@@ -56,6 +62,7 @@ Suite</a>.</p>
</tr><tr>
<td><a href="http://www.xmpp.org/specs/rfc3921.html">RFC 3921</a>: XMPP IM</td>
<td class="supported">Yes</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</a>: Service Discovery</td>
<td class="supported">Yes</td>
......@@ -63,6 +70,7 @@ Suite</a>.</p>
<td><a href="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</a>: In-Band Registration</td>
<td class="supported">Yes</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0078.html">JEP-0078</a>: Non-SASL Authentication</td>
<td class="supported">Yes</td>
</tr><tr>
......@@ -70,6 +78,7 @@ Suite</a>.</p>
<td class="supported">Yes</td>
</tr>
</table>
<br>
<a name="intermediate"></a>
......@@ -84,6 +93,7 @@ Suite</a>.</p>
<tr>
<th>Specification</th>
<th width="35%">Supported</th>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0073.html">JEP-0073</a>: Basic IM Protocol Suite</td>
<td class="supported">Yes</td>
......@@ -91,6 +101,7 @@ Suite</a>.</p>
<td><a href="http://www.jabber.org/jeps/jep-0004.html">JEP-0004</a>: Data Forms</td>
<td class="supported">Yes</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0020.html">JEP-0020</a>: Feature Negotiation</td>
<td class="unsupported">No</td>
</tr><tr>
......@@ -98,6 +109,7 @@ Suite</a>.</p>
<td class="supported">Yes</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0047.html">JEP-0047</a>: In-Band Bytestreams</td>
<td class="supported">Yes</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0065.html">JEP-0065</a>: SOCKS5 Bytestreams</td>
......@@ -105,12 +117,14 @@ Suite</a>.</p>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0071.html">JEP-0071</a>: XHTML-IM</td>
<td class="supported">Yes [<a href="#fn1">1</a>]</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0096.html">JEP-0096</a>: File Transfer</td>
<td class="supported">Yes</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0115.html">JEP-0115</a>: Entity Capabilities</td>
<td class="partially_supported">Yes [<a href="#fn2">2</a>]</td>
</tr>
</table>
<br>
......@@ -130,12 +144,14 @@ JEPs that only require client-side support are omitted.</p>
<td><a href="http://www.jabber.org/jeps/jep-0004.html">JEP-0004</a>: Data Forms</td>
<td>Intermediate</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0012.html">JEP-0012</a>: Last Activity</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0013.html">JEP-0013</a>: Flexible Offline Message Retrieval</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</a>: Service Discovery</td>
<td>Basic</td>
</tr><tr>
......@@ -143,6 +159,7 @@ JEPs that only require client-side support are omitted.</p>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</a>: Multi-User Chat</td>
<td>Intermediate</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0049.html">JEP-0049</a>: Private XML Storage</td>
......@@ -150,12 +167,14 @@ JEPs that only require client-side support are omitted.</p>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0050.html">JEP-0050</a>: Ad-Hoc Commands</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0054.html">JEP-0054</a>: vcard-temp</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0055.html">JEP-0055</a>: Jabber Search [<a href="#fn3">3</a>]</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0060.html">JEP-0060</a>: Publish-Subscribe</td>
<td>-</td>
......@@ -163,6 +182,7 @@ JEPs that only require client-side support are omitted.</p>
<td><a href="http://www.jabber.org/jeps/jep-0065.html">JEP-0065</a>: SOCKS5 Bytestreams</td>
<td>Intermediate</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</a>: In-Band Registration</td>
<td>Basic</td>
</tr><tr>
......@@ -170,6 +190,7 @@ JEPs that only require client-side support are omitted.</p>
<td>Basic</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0082.html">JEP-0082</a>: Jabber Date and Time Profiles</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0086.html">JEP-0086</a>: Error Condition Mappings</td>
......@@ -177,6 +198,7 @@ JEPs that only require client-side support are omitted.</p>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0090.html">JEP-0090</a>: Entity Time</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0091.html">JEP-0091</a>: Delayed Delivery</td>
<td>-</td>
......@@ -184,6 +206,7 @@ JEPs that only require client-side support are omitted.</p>
<td><a href="http://www.jabber.org/jeps/jep-0092.html">JEP-0092</a>: Software Version</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0096.html">JEP-0096</a>: File Transfer</td>
<td>Intermediate</td>
</tr><tr>
......@@ -191,6 +214,7 @@ JEPs that only require client-side support are omitted.</p>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0114.html">JEP-0114</a>: Jabber Component Protocol</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0128.html">JEP-0128</a>: Service Discovery Extensions</td>
......@@ -198,9 +222,7 @@ JEPs that only require client-side support are omitted.</p>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0138.html">JEP-0138</a>: Stream Compression</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0164.html">JEP-0164</a>: vCard Filtering</td>
<td>-</td>
</tr><tr>
<td><a href="http://www.jabber.org/jeps/jep-0175.html">JEP-0175</a>: Best Practices for Use of SASL ANONYMOUS</td>
<td>-</td>
......@@ -219,5 +241,10 @@ JEPs that only require client-side support are omitted.</p>
[<a name="fn3">3</a>] Support for <u>JEP-0055: Jabber Search</u> is provided by the <a href="http://www.jivesoftware.org/wildfire/plugins.jsp">Search plugin</a>.
<br>
</div>
</div>
</body>
</html>
documentation/docs/source-build.html
View file @ a61ed402
......@@ -2,38 +2,28 @@
<html>
<head>
<title>Wildfire Source Instructions</title>
<link href="style.css" rel="stylesheet" type="text/css">
<style type="text/css">
.code {
font-family : courier new;
border : 1px #ccc solid;
padding : 6px;
margin : 5px 20px 5px 20px;
}
TT {
font-family : courier new;
font-weight : bold;
color : #060;
}
PRE, CODE {
font-family : courier new;
font-size : 100%;
}
.footer {
font-size : 0.8em;
color : #666;
text-align : center;
}
</style>
<title>Jive Software - Wildfire: Building the Source</title>
<link href="style.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<body>
<h1>Wildfire Source Instructions</h1>
<p>
<div id="pageContainer">
<a name="top"></a>
<div id="pageHeader">
<div id="logo"></div>
<h1>Building the Source</h1>
</div>
<div class="navigation">
<a href="index.html">&laquo; Back to documentation index</a>
</div>
<div id="pageBody">
This document provides detailed information for developers that wish to
<p>This document provides detailed information for developers that wish to
compile and make changes to the Wildfire source code.
Use of the source code is governed by the GPL or the commercial license
you purchased for the codebase from Jive Software.
......@@ -55,9 +45,10 @@ in this distribution.
<p>
This documentation is divided into three sections:
<ol>
<li> <a href="#source">Source</a> -- get the Wildfire source code.
<li> <a href="#source">Source</a> -- get te Wildfire source code.
<li> <a href="#setup">Setup</a> -- how to setup your environment for Wildfire development.
<li> <a href="#tasks">Build tasks</a> -- tasks that can be performed using the build program.
</ol>
<p><a name="source"><b><font color="#0066cc">1.</font> Get the Wildfire Source</b></a><p>
......@@ -71,6 +62,7 @@ be found on the <a href="http://www.jivesoftware.org/source.jsp">source page</a>
Getting your machine ready for development requires a few steps. Wherever
possible, instructions are provided for both Unix/Linux and Windows users.
<p>
<b><a name="javaSetup">Configure Java for Wildfire</a></b>
<ul>
Java 5 (JDK 1.5) must be installed and setup on your machine. To test the installation,
......@@ -87,6 +79,7 @@ possible, instructions are provided for both Unix/Linux and Windows users.
<ul>
<li> Unix/Linux
<ol>
<li>Edit the ".profile" file in your home directory (or
corresponding file for your shell).
<li>Set the JAVA_HOME environment variable by adding the
......@@ -103,6 +96,7 @@ possible, instructions are provided for both Unix/Linux and Windows users.
source .profile
</span>
<p>
The JAVA_HOME variable should now be configured correctly.
</ol>
<p>
......@@ -123,6 +117,7 @@ possible, instructions are provided for both Unix/Linux and Windows users.
correctly.
</ol>
<p>
<li> Windows95/98
<ol>
<li>Open your autoexec.bat file (often at "c:\autoexec.bat") using Notepad.
......@@ -137,6 +132,7 @@ possible, instructions are provided for both Unix/Linux and Windows users.
not add an extra slash after the directory name.
<li>Save changes to autoexec.bat and restart your computer.
</ol>
</ul>
</ul>
......@@ -165,6 +161,7 @@ Now, invoke the build tool to compile the Wildfire source code
<p>
Windows:<span class="code"> ant <br> </span><br clear="left">
Unix/Linux:<span class="code"> ./ant </span>
<p>
......@@ -199,6 +196,7 @@ with the build tool.
one of the targets listed below:
<ul>
<li><a href="#noparams"><i>Default</i></a>
<li><a href="#jar">jar</a>
<li><a href="#plugins">plugins</a>
......@@ -210,6 +208,7 @@ for each task are enclosed with braces. If you would like to permanently set the
value of a property, add it to build/build.xml file.
<!-- default -->
<p><b><a name="noparams"><i>Default</i></a></b>
<ul>
<i>Syntax:</i><p>
......@@ -220,6 +219,7 @@ value of a property, add it to build/build.xml file.
Equivalent of calling "ant <a href="#jar">jar</a> javadoc".
<p>[<a href="#tasks">return to task list</a>]
</ul>
......@@ -240,6 +240,7 @@ Wildfire using the scripts in <tt>target/bin/</tt>.
<!--PLUGINS-->
<p><b><a name="jar">plugins</a></b>
<ul>
<i>Syntax:</i><p>
......@@ -249,6 +250,7 @@ Wildfire using the scripts in <tt>target/bin/</tt>.
Builds all plugins into the <tt>target/plugins</tt> directory.
<p>[<a href="#tasks">return to task list</a>]
</ul>
<!--CLEAN-->
......@@ -261,10 +263,16 @@ Builds all plugins into the <tt>target/plugins</tt> directory.
<p><i>Description:</i></p>
Cleans all artifacts of the build process by deleting the <tt>target/</tt>
directory.<p>
<p>[<a href="#tasks">return to task list</a>]
</ul>
</div>
</div>
</body>
</html>
documentation/docs/ssl-guide.html
View file @ a61ed402
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Wildfire SSL Guide</title>
<link type="text/css" rel="stylesheet" href="style.css">
<title>Jive Software - Wildfire: SSL Guide</title>
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<div id="pageContainer">
<a name="top"></a>
<h1>Wildfire SSL Guide</h1>
<div id="pageHeader">
<div id="logo"></div>
<h1>SSL Guide</h1>
</div>
<div class="navigation">
<a href="index.html">&laquo; Back to documentation index</a>
</div>
<div id="pageBody">
<h2>Introduction</h2>
<p>
This document outlines how to customize the SSL support in Wildfire.
<font color="red"><b>Important note:</b></font>
because Wildfire ships with self-signed certificates, it will work out of the box without
installing your own certificate. However, most users will wish to user their own
......@@ -52,6 +67,7 @@ reaction to a self-signed certificate is to ask the user whether
to trust the certificate, or to silently trust the certificate is
legitimate. Unfortunately, blindly accepting self-signed certificates
opens up the system to 'man-in-the-middle' attacks.
</p>
<p>
The advantage of a self-signed certificate is you can create them for
......@@ -81,6 +97,7 @@ encrypted files. The <tt>keytool</tt> is used to create, read, update,
and delete entries in these files. Wildfire ships with a self-signed
"dummy" certificate designed for initial evaluation testing. You will need
to adjust the default configuration for most deployments.
</p>
<p>
In order to configure SSL on your server you need complete the
......@@ -96,6 +113,7 @@ If so, you can skip to step 4.</li>
server certificate.
<ol style="list-style-type: lower-alpha;">
<li>Generate a certificate signing request (CSR).</li>
<li>Submit your CSR to a CA for signing.</li>
</ol>
</li>
......@@ -107,6 +125,7 @@ skip this step.</li>
<li>Import client certificates into the truststore.</li>
<li>Adjust the Wildfire configuration with proper keystore and
truststore settings.</li>
</ol>
<h3>1. Decide on a Server Domain</h3>
<p>
......@@ -123,6 +142,7 @@ directory of your Wildfire installation. You should see the default
<tt>keystore</tt> and <tt>truststore</tt> files. First, you should
change the default keystore
password:
</p>
<p><tt>keytool -storepasswd -keystore keystore</tt></p>
<p>
......@@ -140,6 +160,7 @@ After you have entered all the required information, keytool will ask you to
verify the information and set a key password.
<b>You must use the same key password as the store password.</b> By default
you get this by simply hitting 'enter' when prompted for a key password.</p>
<p>If you later change the keystore password remember to change the entries'
password as well using the keytool:</p>
......@@ -155,6 +176,7 @@ standard CSR format. You can do this with the keytool:
certificate_file</tt></p>
<p>
Where you should substitute your server's name for <tt>example.com</tt>
and the name of the
certificate file you wish to produce for <tt>certificate_file</tt>.
Submit the generated CSR to the CA and follow their instructions to get
......@@ -174,6 +196,7 @@ you'll receive an error.
</p>
<h3>5. Remove default certificates</h3>
<p>
After importing your certificate you must remove the default certificates
using the keytool.
</p>
......@@ -191,6 +214,7 @@ password:
keytool will ask for the old password (by default it is <tt>changeit</tt>)
then the new password.
Now import each certificate using the keytool:
</p>
<p><tt>keytool -import -keystore truststore -alias user_name -file
certificate_file</tt></p>
......@@ -206,6 +230,7 @@ browser and add or change the following system properties:
<li>xmpp.socket.ssl.storeType -- the store type used ("JKS" is
the Sun Java Keystore format used by the JDK keytool). If this property is
not defined, Wildfire will assume a value of "jks".</li>
<li>xmpp.socket.ssl.keystore -- the location of the keystore file
relative to your Wildfire installation root directory. You can leave this property
blank to use the default keystore.</li>
......@@ -218,5 +243,10 @@ your Wildfire installation root directory.</li>
changed in step 6.</li>
</ul>
You will need to restart the server after you have modified any of the above system properties.
</div>
</div>
</body>
</html>
documentation/docs/style.css
View file @ a61ed402
BODY {
font-size : 100%;
background-color : #fff;
}
BODY, TD, TH {
font-family : arial, helvetica, sans-serif;
font-size : 10pt;
}
PRE, TT, CODE {
font-family : courier new, monospaced;
font-size : 9pt;
}
A:hover {
text-decoration : none;
}
LI {
padding-bottom : 4px;
}
H1 {
font-size : 1.4em;
font-weight : bold;
width : 100%;
border-bottom : 1px #ccc solid;
padding-bottom : 2px;
}
H2 {
font-size : 1.2em;
font-weight : bold;
}
H3 {
font-size : 1.0em;
font-weight : bold;
}
TT {
font-family : courier new;
font-weight : bold;
color : #060;
}
FIELDSET PRE {
padding : 1em;
margin : 0px;
}
FIELDSET {
margin-left : 2em;
margin-right : 2em;
border : 1px #ccc solid;
-moz-border-radius : 5px;
/* global font and body settings */
body {
font-size : 100%;
background-color : #d3d6d9;
padding: 0px;
color: #33333;
margin: 0px 0px 30px 0px;
}
body, td, th {
font-family : arial, helvetica, sans-serif;
font-size : 10pt;
}
pre, tt, code {
font-family : courier new, monospaced;
font-size : 9pt;
}
#pageContainer {
display: block;
position: relative;
clear: all;
background-color: #fff;
border: 1px solid #999;
padding: 40px;
margin: 30px;
-moz-border-radius: 6px;
}
#pageHeader {
display: block;
position: relative;
height: 80px;
background-color: #e7eaee;
border: 1px solid #cccccc;
border-bottom: none;
-moz-border-radius: 5px 5px 0px 0px;
margin: 10px 0px 0px 0px;
}
#pageBody {
margin: 0px 18px 0px 20px;
}
.comment {
color : #666;
font-style : italic;
/* anchors */
a:link {
color: #11568c;
}
a:visited {
color: #571c8d;
}
a:hover {
color: #7a1d42;
text-decoration : underline;
}
a:active {
color: #7a1d42;
}
/* page header elements (logo and navigation) */
#logo {
display: block;
position: relative;
background: url(images/header_logo.gif) no-repeat;
width: 135px;
height: 40px;
margin: 21px 20px 0px 0px;
overflow: hidden;
float: right;
}
.navigation {
display: block;
position: relative;
height: 20px;
background-color: #335588;
border: 1px solid #cccccc;
border-top: none;
color: #ffffff;
font-size: 11px;
line-height: 18px;
padding: 0px 0px 0px 0px;
margin: 0px 0px 25px 0px;
overflow: hidden;
}
.navigation a {
margin: 0px 0px 0px 20px;
}
.navigation a:link { color: #ffffff; }
.navigation a:visited { color: #ffffff; }
.navigation a:hover { color: #ffffff; }
.navigation a:active { color: #ffffff; }
/* headings */
h1 {
display: block;
position: relative;
font-size : 1.7em;
font-weight : bold;
color: #670e15;
padding: 0px;
margin: 30px 0px 0px 20px;
}
h2 {
font-size : 1.3em;
font-weight : bold;
margin: 40px 0px 6px 0px;
padding: 0px;
color: #335588;
}
h3 {
font-size : 1.0em;
font-weight : bold;
margin: 25px 0px 3px 0px;
padding: 0px;
color: #334466;
}
/* general elements */
p {
margin: 0px 0px 15px 0px;
}
ul {
margin: 5px 0px 15px 35px;
}
li {
padding-bottom : 4px;
}
tt {
font-family : courier new;
font-weight : bold;
color : #060;
}
hr {
display: block;
height: 1px;
background-color: #999999;
border: none;
margin: 40px 0px 20px 0px;
}
fieldset pre {
padding : 1em;
margin : 0px;
}
fieldset {
margin-left : 2em;
margin-right : 2em;
border : 1px #ccc solid;
-moz-border-radius : 5px;
}
/* classes */
.comment {
color : #666;
font-style : italic;
}
.subheader {
font-weight : bold;
font-weight : bold;
}
.footer {
font-size : 0.8em;
color : #999;
text-align : center;
width : 100%;
border-top : 1px #ccc solid;
padding-top : 2px;
font-size : 0.8em;
color : #999;
text-align : center;
width : 100%;
border-top : 1px #ccc solid;
padding-top : 2px;
}
.code {
border : 1px #ccc solid;
padding : 0em 1.0em 0em 1.0em;
margin : 4px 0px 4px 0px;
}
.nav, .nav A {
font-family : verdana;
font-size : 0.85em;
color : #600;
text-decoration : none;
font-weight : bold;
display: block;
width: auto;
border : 1px #ccc solid;
padding : 6px;
margin : 10px 20px 10px 20px;
}
.note {
font-family : verdana;
font-size : 0.85em;
color : #600;
text-decoration : none;
font-weight : bold;
font-family : verdana;
font-size : 0.85em;
color : #600;
text-decoration : none;
font-weight : bold;
}
.nav, .nav a {
font-family : verdana;
font-size : 0.85em;
color : #600;
text-decoration : none;
font-weight : bold;
}
.nav {
width : 100%;
border-bottom : 1px #ccc solid;
padding : 3px 3px 5px 1px;
width : 100%;
border-bottom : 1px #ccc solid;
padding : 3px 3px 5px 1px;
}
.nav a:hover {
text-decoration : underline;
}
.nav A:hover {
text-decoration : underline;
}.question {
.question {
font-weight: 600;
}
.answer {
......@@ -97,21 +211,31 @@ FIELDSET {
.toc {
right: 5px;
}
TABLE.dbtable {
border : 1px #ccc solid;
width : 600px;
table.dbtable {
border : 1px #ccc solid;
width : 600px;
}
TR, TH {
border-bottom : 1px #ccc solid;
tr, th {
border-bottom : 1px #ccc solid;
}
TH, TD {
padding-right : 15px;
th, td {
padding-right : 15px;
}
TH {
text-align : left;
white-space : nowrap;
background-color : #eee;
th {
text-align : left;
white-space : nowrap;
background-color : #eee;
}
.primary-key {
background-color : #ffc;
background-color : #ffc;
}
/* Protocol support specific styles */
.supported { background-color: #D0FFCB }
.partially_supported { background-color: #FEFF94 }
.unsupported { background-color: #FFB4B4 }
documentation/docs/translator-guide.html
View file @ a61ed402
......@@ -2,16 +2,26 @@
<html>
<head>
<title>Wildfire Translator Guide</title>
<link href="style.css" rel="stylesheet" type="text/css">
<title>Jive Software - Wildfire: Translator Guide</title>
<link href="style.css" rel="stylesheet" type="text/css">
</head>
<body>
<h1>Wildfire Translator Guide</h1>
<div id="pageContainer">
<a name="top"></a>
<div id="pageHeader">
<div id="logo"></div>
<h1>Translator Guide</h1>
</div>
<div class="navigation">
<a href="index.html">&laquo; Back to documentation index</a>
</div>
<div id="pageBody">
<h2>Introduction</h2>
<p>
......@@ -34,6 +44,7 @@ Key/value pairs in the English resource bundle might look like the following:
The German resource bundle would contain the same keys, but different values:
<br>
<pre>
skin.yes=<i>Ja</i>
skin.no=<i>Nein</i>
skin.topic=<i>Thema</i>
......@@ -111,7 +122,12 @@ property.</p>
<p>Once your translation is complete and tested, please submit it to the Wildfire
developers so that others can enjoy it in the next release!</p>
<br><br>
<br>
<br>
</div>
</div>
</body>
</html>
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