Changes between Version 20 and Version 21 of AccountManagerPlugin

Timestamp:

Aug 6, 2006, 8:37:55 PM (18 years ago)

Author:

Matt Good

Comment:

add more documentation of the components

AccountManagerPlugin

@@ -69 +69 @@
 }}}
 
+The available components are describe below.
+
+=== !AccountManager ===
+
+ '''Package''':: acct_mgr.api
+
+This is the core of this plugin.  This components ''must'' be enabled to use any of the other components.
+
+=== !HtDigestStore ===
+ '''Package''':: acct_mgr.htfile
+
+Used to store passwords in the htdigest file format.
+
+To use this component to manage your password file you need to enable it as described above and add some additional configuration to [trac:TracIni trac.ini]:
+
+{{{
+[account-manager]
+; configure the plugin to store passwords in the htdigest format:
+password_format = htdigest
+; with Trac 0.10 use this instead:
+password_store = HtDigestStore
+
+; the file where user accounts are stored
+; the webserver will need write permissions to this file
+; and its parent folder
+password_file = /var/trac/trac.htdigest
+
+; the name of the authentication "realm"
+; it can be any text to identify your site or project
+htdigest_realm = TracRealm
+}}}
+
+=== !HtPasswdStore ===
+ '''Package''':: acct_mgr.htfile
+
+Used to store passwords in the htpasswd file format.
+
+To use this component to manage your password file you need to enable it as described above and add some additional configuration to [trac:TracIni trac.ini]:
+
+{{{
+[account-manager]
+; configure the plugin to store passwords in the htdigest format:
+password_format = htpasswd
+; with Trac 0.10 use this instead:
+password_store = HtPasswdStore
+
+; the file where user accounts are stored
+; the webserver will need write permissions to this file
+; and its parent folder
+password_file = /var/trac/trac.htpasswd
+}}}
+
+=== !AccountManagerAdminPage ===
+ '''Package''':: acct_mgr.admin
+
+'''Note:''' This component requires Trac 0.10
+
+This component adds a new page to the trac:WebAdmin section for managing user accounts.  It requires the `TRAC_ADMIN` permission to access.
+
+[[Image(account-manager-admin.png)]]
+
+=== !AccountModule ===
+ '''Package''':: acct_mgr.web_ui
+
+Allows users to change their password, or delete their account.  When logged in it will appear as a link "My Account" in the same row as the "Login" link.
+
+[[Image(my-account.png)]]
+
+'''New for Trac 0.10:''' When used in combination with the [wiki:AccountManager#LoginModule LoginModule] it adds a link to the login page "Forgot your password?" where users can reset their password if they've forgotten it.
+
+[[Image(reset-password.png)]]
+
 == Example ==