Changes between Version 20 and Version 21 of AccountManagerPlugin


Ignore:
Timestamp:
Aug 6, 2006, 10:37:55 PM (8 years ago)
Author:
mgood
Comment:

add more documentation of the components

Legend:

Unmodified
Added
Removed
Modified
  • AccountManagerPlugin

    v20 v21  
    6969}}}
    7070
     71The available components are describe below.
     72
     73=== !AccountManager ===
     74
     75 '''Package''':: acct_mgr.api
     76
     77This is the core of this plugin.  This components ''must'' be enabled to use any of the other components.
     78
     79=== !HtDigestStore ===
     80 '''Package''':: acct_mgr.htfile
     81
     82Used to store passwords in the htdigest file format.
     83
     84To 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]:
     85
     86{{{
     87[account-manager]
     88; configure the plugin to store passwords in the htdigest format:
     89password_format = htdigest
     90; with Trac 0.10 use this instead:
     91password_store = HtDigestStore
     92
     93; the file where user accounts are stored
     94; the webserver will need write permissions to this file
     95; and its parent folder
     96password_file = /var/trac/trac.htdigest
     97
     98; the name of the authentication "realm"
     99; it can be any text to identify your site or project
     100htdigest_realm = TracRealm
     101}}}
     102
     103=== !HtPasswdStore ===
     104 '''Package''':: acct_mgr.htfile
     105
     106Used to store passwords in the htpasswd file format.
     107
     108To 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]:
     109
     110{{{
     111[account-manager]
     112; configure the plugin to store passwords in the htdigest format:
     113password_format = htpasswd
     114; with Trac 0.10 use this instead:
     115password_store = HtPasswdStore
     116
     117; the file where user accounts are stored
     118; the webserver will need write permissions to this file
     119; and its parent folder
     120password_file = /var/trac/trac.htpasswd
     121}}}
     122
     123=== !AccountManagerAdminPage ===
     124 '''Package''':: acct_mgr.admin
     125
     126'''Note:''' This component requires Trac 0.10
     127
     128This component adds a new page to the trac:WebAdmin section for managing user accounts.  It requires the `TRAC_ADMIN` permission to access.
     129
     130[[Image(account-manager-admin.png)]]
     131
     132=== !AccountModule ===
     133 '''Package''':: acct_mgr.web_ui
     134
     135Allows 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.
     136
     137[[Image(my-account.png)]]
     138
     139'''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.
     140
     141[[Image(reset-password.png)]]
     142
    71143== Example ==
    72144