openfire-jmxweb-plugin/readme.html at main · igniterealtime/openfire-jmxweb-plugin · GitHub

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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
<head>
    <title>JmxWeb 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%;
        }

        .events TH {
            font-size: 8pt;
            font-family: verdana;
            font-weight: bold;
            text-align: left;
            background-color: #eee;
            border-bottom: 1px #ccc solid;
        }

        .events .event {
            font-weight: bold;
        }

        .events .description {
            font-size: 8pt;
            font-family: verdana;
        }

        .events TD {
            border-bottom: 1px #ccc dotted;
            vertical-align: top;
        }
    </style>
</head>

<body>

<h1>
    JmxWeb Plugin Readme
</h1>

<p>
JmxWeb plugin is web based platform for managing and monitoring openfire via JMX. It includes hawtio, a lightweight and modular HTML5 web console with lots of plugins and jolokia a JMX-HTTP bridge providing a web based alternative to JSR-160 connectors.
It also includes the mbeans from the java-monitor probe for openfire.
</p>

<h2>Prerequesites</h2>

<p>

</p>

<h2>Installation</h2>

<ol>
    <li>Stop Openfire.</li>
    <li>Copy the jmxweb.jar file to the OPENFIRE_HOME/plugins directory.</li>
    <li>Restart Openfire.</li>
</ol>

<h2>Configuration</h2>

<p>If you want to monitor openfire JMX mbeans, enable JMX by adding the following to System Properties via the Web Admin Console or add into the table ofproperty.</p>

<ul>
<li>xmpp.jmx.enabled (true or false)</li>
<li>xmpp.jmx.secure (true or false)</li>
</ul>
<p>If you want your admin users to recieve periodic summary emails of JMX, configure Opefire email service and add the following to System Properties via the Web Admin Console.</p>

<ul>
<li>jmxweb.email.monitoring - (true or false)</li>
<li>jmxweb.crontrigger.schedule - (a <a href="http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html">cron-trigger expression</a>. The default setting is "0 0 0/12 * * ?" which means run report daily, twice a day at 12 midnight and 12 noon.)</li>
<li>jmxweb.admin.username - any valid admin user name. Required if >xmpp.jmx.secure is set to true</li>
<li>jmxweb.admin.password - the password for above admin user. Required if >xmpp.jmx.secure is set to true</li>
</ul>
<p><img src="https://discourse.igniterealtime.org/uploads/default/optimized/2X/a/ab089b865566fedea428964df370d9b49621c395_1_690x388.jpg" style="width: 620px; height: 349px;" __jive_id="33840" /></p>
<h2>How to use</h2>
<p><span>To access hawtio, point your browser at </span><a href="http://your-server:7070/hawtio" rel="nofollow" target="_blank">http://your-server:7070/hawtio</a></p>
<p><span>To access jolokia rest api from your javascript applications use URL </span><a href="http://your-server:7070/jolokia" rel="nofollow" target="_blank">http://your-server:7070/jolokia</a><span>. Make sure you provide headers for basic authentication.</span></p>
<p></p>
<p><img src="https://discourse.igniterealtime.org/uploads/default/optimized/2X/3/328bb93bab08644af2b1e44d5ffa081504874983_1_690x434.jpg" style="width: 620px; height: 391px;" __jive_id="33841" /></p>
</body>
</html>