readme.html 2.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
<head>
	<title>GoJara Plugin Readme</title>
    <style type="text/css">
        BODY {
            font-size : 100%;
        }
        BODY, TD, TH {
            font-family : tahoma, verdana, arial, helvetica, sans-serif;
            font-size : 0.8em;
        }
        H2 {
             font-size : 10pt;
             font-weight : bold;
        }
        A:hover {
            text-decoration : none;
        }
        H1 {
            font-family : tahoma, arial, helvetica, sans-serif;
            font-size : 1.4em;
            font-weight: bold;
            border-bottom : 1px #ccc solid;
            padding-bottom : 2px;
        }

        TT {
            font-family : courier new;
            font-weight : bold;
            color : #060;
        }
        PRE {
            font-family : courier new;
            font-size : 100%;
        }
        #datatable TH {
            color : #fff;
            background-color : #2A448C;
            text-align : left;
        }
        #datatable TD {
            background-color : #FAF6EF;
        }
        #datatable .name {
            background-color : #DCE2F5;
        }
    </style>
</head>
<body>


<h1>
GoJara Plugin Readme
</h1>

<h2>Overview</h2>

<p>
This plugin will implement the proto-XEP, Remote Roster, discussed
<a href="http://jkaluza.fedorapeople.org/remote-roster.html">here</a>.
Basically it's purpose is to allow an external component full
control over the part of a roster it's assigned.  For example,
if the AIM transport is at aim.example.org, you can allow that transport
to make whatever modifications it needs without involving the end user.
This is especially useful so that a user does not get flooded with
subscription requests upon registration.  This plugin also implements
a few minor extensions that Kraken used to implement for Spark, though
those are optional.
Axel Brand's avatar
Axel Brand committed
71 72
You can also use it for viewing gateway sessions, managing existing gateway-registrations
and looking into basic Spectrum2 related Statistics 
73 74 75 76
</p>

<h2>Installation</h2>

Axel Brand's avatar
Axel Brand committed
77
<p>Copy gojara.jar into the plugins directory of your Openfire installation. The
78
plugin will then be automatically deployed. To upgrade to a new version, copy the new
Axel Brand's avatar
Axel Brand committed
79
gojara.jar file over the existing file.</p>
80 81 82 83

<h2>Configuration</h2>

<p>The GoJara plugin can be configured under "Server"-"Server Settings"-"GoJara".</p>
Axel Brand's avatar
Axel Brand committed
84 85 86
<p>For Spectrum2 Statistics to work you need to additionaly configure spectrum2 transports to
include admin_jid = gojaraadmin@domain. This way we can gather info like used Memory and unregister
Users from Openfire Console</p>
87 88
</body>
</html>