Commit a5f0022e authored by Matt Tucker's avatar Matt Tucker Committed by matt

Added readmin, changelog, updated version.


git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@1223 b35dd754-fafc-0310-a699-88a17e54d16e
parent b5aefe7a
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Broadcast Plugin Changelog</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;
padding-left : 1em;
}
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%;
}
</style>
</head>
<body>
<h1>
Broadcast Plugin Changelog
</h1>
<p><b>1.2</b> -- April 11, 2005</b></p>
<ul>
<li>Now requires Jive Messenger 2.1.3</li>
<li>Listens for properties being set and removed.
</ul>
<p><b>1.1</b> -- Feb 21, 2005</b></p>
<ul>
<li>Updated to new plugin API.</li>
</ul>
<p><b>1.0</b> -- Jan 15, 2005</p>
<ul>
<li>Initial release. </li>
</ul>
</body>
</html>
\ No newline at end of file
...@@ -8,6 +8,6 @@ ...@@ -8,6 +8,6 @@
<name>Broadcast</name> <name>Broadcast</name>
<description>Broadcasts messages to users.</description> <description>Broadcasts messages to users.</description>
<author>Jive Software</author> <author>Jive Software</author>
<version>1.1</version> <version>1.2</version>
<minMessengerVersion>2.1.2</minMessengerVersion> <minMessengerVersion>2.1.2</minMessengerVersion>
</plugin> </plugin>
\ No newline at end of file
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Broadcast 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%;
}
</style>
</head>
<body>
<h1>
Broadcast Plugin Readme
</h1>
<h2>Overview</h2>
<p>
The broadcast plugin broadcasts messages to all users in the system or to specific groups. It's
primarily useful for sending announcements or notifications.
</p>
<h2>Installation</h2>
<p>Copy broadcast.jar into the plugins directory of your Jive Messenger installation. The
plugin will then be automatically deployed. To upgrade to a new version, copy the new
broadcast.jar file over the existing file.</p>
<h2>Configuration</h2>
The broadcast plugin is configured via Jive Messenger system properties. These can
be configured under Server/Server Manager/System Properties:
<ul>
<li><tt>plugin.broadcast.serviceName</tt> -- the name of the broadcast service. If no value
is set, the default is "broadcast".</li>
<li><tt>plugin.broadcast.disableGroupPermissions</tt> -- true to allow any user to
broadcast a message to a group. When false, only group members or administrators can
broadcast messages to a group. The default value is false.</li>
<li><tt>plugin.broadcast.groupMembersAllowed</tt> -- true to also allow group members
to send broadcast messages to groups they belong to. When false, only administrators can
send broadcast messages to a group. The default value is true. Note that the property value
of <tt>plugin.broadcast.disableGroupPermissions</tt> can effectively override this value
by letting anyone send broadcast messages to groups.</li>
<li><tt>plugin.broadcast.allowedUsers</tt> -- the comma-delimitted list of users allowed
to broadcast messages to all connected users at once. When this property isn't set,
anyone is allowed to broadcast messages to all users.</li>
</ul>
<h2>Using the Plugin</h2>
To send a broadcast message, send a message to all@[serviceName].[serverName] or
[group]@[serviceName].[serverName]. For example, if your server is called foo and the
default service name is being used, a message to all@broadcast.foo would be broadcast to
all users connected to the server. For the group staff, a message to staff@broadcast.foo would
be sent to all users in the group staff that are currently online.
</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