readme.html 2.39 KB
Newer Older
Ryan Graham's avatar
Ryan Graham committed
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
<!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>
53
Copy the registration.jar into the plugins directory of your Wildfire installation. The plugin will
Ryan Graham's avatar
Ryan Graham committed
54 55 56 57 58 59
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>
60
The registration plugin is configured via the "Registration Properties" sidebar item located in the
61
"Users" sidebar item under the "Users/Groups" tab in the Wildfire Admin Console. By default,
Ryan Graham's avatar
Ryan Graham committed
62 63 64
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 three items that can be configured:
Ryan Graham's avatar
Ryan Graham committed
65
</p>
66 67 68 69
<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>
70
<li>Web Page Registration - Allows users to create accounts via a web page.
Ryan Graham's avatar
Ryan Graham committed
71 72 73 74 75 76 77 78

<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>