openfire-registration-plugin/readme.html at main · igniterealtime/openfire-registration-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>Registration 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>
Registration Plugin Readme
</h1>

<h2>Overview</h2>
<p>
The registration plugin allows admins to configure various actions whenever a new user creates an account.
</p>

<h2>Installation</h2>
<p>
Copy the registration.jar into the plugins directory of your Openfire installation. The plugin will
then be automatically deployed. To upgrade to a new version, copy the new registration.jar file over
the existing file.
</p>

<h2>Configuration</h2>
<p>
The registration plugin is configured via the "Registration Properties" sidebar item located in the
"Users" sidebar item under the "Users/Groups" tab in the Openfire Admin Console. By default,
after the registration plugin has been deployed all of its features are disabled. To enable a feature
of the plugin select the checkbox next to the feature and then click on the "Save Settings" button.
The registration plugin has various items that can be configured:
</p>
<ul>
<li>Account expiry - Disables new accounts after a certain amount of time has passed.</li>
<li>Registration Notification - Contacts can be configured to receive an instant message and/or email to
notify them whenever a new user registers.</li>
<li>Welcome Message - A message that will be sent to a user when they first register.</li>
<li>Default Group - A group that all users will be added to when they first register.</li>
<li>Web Page Registration - Allows users to create accounts via a web page.</li>
<li>Default Privacy List - A privacy list added and set as default for all users when they register.</li>
</ul>

<h2>Public web registration form</h2>
<p>
The plugin can make available a public web page that can be used by your users to register new accounts. Optionally,
Google's reCAPTCHA v3 verification service can be used to protect against abuse of this service.
</p>
<p>
To enable the reCAPTCHA verification, you should follow the instructions provided by Google, at
<a href="https://www.google.com/recaptcha/" target="_blank">https://www.google.com/recaptcha/</a>. At the moment of
writing, the process to sign up for the service is:
</p>
<ol>
<li>Open the reCAPTCHA Admin Console</li>
<li>Create a new site</li>
<li>Select as type: v3</li>
<li>Fill out the domain name on which the public signup page will be accessible</li>
<li>Copy the 'site key' and 'secret key', and save this in the Openfire Admin Console</li>
</ol>
<p>
It is advisable to manually test the sign-up page afterwards, by creating a new user.
</p>

<h2>Default Privacy List</h2>
<p>The format used is an XML that should look like :</p>
<pre><code>&lt;list&gt;
&lt;item action="deny" order="100" type="subscription" value="none"&gt;
     &lt;message/&gt;
     &lt;presence-in/&gt;
     &lt;presence-out/&gt;
&lt;/item&gt;
&lt;/list&gt;
</code></pre>
<p>
The enclosing list tag is needed, but none of its attributes are read. Inside it you can have multiple items.
</p>

<h2>Using the Plugin</h2>
<p>
Presently, after the registration plugin has been configured nothing else needs to be done to use it.
</p>

</body>
</html>