Version 149 (modified by 11 years ago) (diff) | ,
---|
Contents
ToDo
- short-term:
- mid-term: release acct_mgr-0.5, fork afterwards, especially to switch support to Trac (1.0) db API
- long-term:
- include some other Trac plugin's code and eventually obsolete these as separate hacks:
- continue code review, increasing unit test coverage and bug squashing...
News
- 27-Dec-2012
- Maintenance release acct_mgr-0.4.2 - for Trac 0.11 .. 1.0 (open: 40)
- 01-Dec-2012
- Stable release acct_mgr-0.4 (open: 39)
- 11-Aug-2012
- Plug-able registration process using new
IAccountRegistrationInspector
interface (open: 74) - 07-Jul-2011
- Stable release acct_mgr-0.3 (open: 36)
- 26-Sep-2010
- Starting ticket list cleanup and triaging (open: 96)
Account Manager Plugin
Description
The AccountManagerPlugin offers features for managing user accounts and more:
- enable authentication through a number of built-in authentication resources and some more by 3rd party extensions
- allow users to register new accounts
- login via an HTML form instead of using HTTP authentication
- allow existing users to change their passwords, even delete their accounts
These features are new in the plugin for Trac 0.10.
- send a new password to users who’ve forgotten their password
- administration of user accounts
These features are new in the plugin for Trac 0.11 and later
- login failure tracking and rule based account locking (temporary or permanent lock)
- per-account details admin page
- password hash refresh and store migration on user login
- i18n support (requires Trac 0.12 or later)
- account meta-data listing from Trac db table
session_attribute
, with cleanup option - Single-Sign-On functionality for applications with multiple Trac environments per domain/host
- mostly account-/user-related WikiMacros
Bugs/Feature Requests
Existing bugs and feature requests for AccountManagerPlugin are here.
If you have any issues that is not found in existing tickets, create a new ticket, please.
You do wonder, if you could contribute here? Great! There are some recommendations, where to start.
In any case, please respect our rules for contributions, that are enforced for this plugin as of 01-Dec-2012.
Install
Prerequisites
First make sure you’ve installed setuptools. Make sure you have a version >= 0.6c9, since previous versions contain a bug which makes the installation fail. Then you can install the plugin using the easy_install
application.
Note: Windows users will need to add easy_install to their PATH.
Release Status, Downloads and Source
While in general the branch name suggests the corresponding Trac version, 0.11
should work equally well for all Trac starting from 0.11 over 0.12 (old stable) up to Trac 1.0 (current stable).
Old, obsolete Version | easy_install https://trac-hacks.org/svn/accountmanagerplugin/0.10 | [download:accountmanagerplugin/0.10 download] | subversion |
Stable Version | easy_install https://trac-hacks.org/svn/accountmanagerplugin/0.11 | [download:accountmanagerplugin/0.11 download] | subversion |
Under Development | easy_install https://trac-hacks.org/svn/accountmanagerplugin/trunk | [download:accountmanagerplugin/trunk download] | subversion |
Browse the source with Trac. For Subversion checkout use svn co <url>
with URL depending on your Trac version and target release (see links above).
Hint: Whether you are using tracd
standalone server or a web-server, you must restart it to detect and load the plugin.
On upgrades from previous plugin versions please see the README.update file included in the source.
About i18n/l10n support
Starting with acct_mgr-0.3 this plugin has been prepared for localization.
But English message texts are still the (POSIX) default. If this isn't your preferred language, you can
- look, if it's already available from the Trac plugin l10n project at Transifex or
- do it yourself (see the l10n cookbook page for Trac plugins for more details).
You've done a new translation? Superb! Contributing your translation is highly appreciated.
You could send it to the plugin's maintainer or contribute to Trac plugin l10n project
via Transifex:
Top translations: Trac_Plugin-L10N » acct_mgr-messages
Left: Status for acct_mgr-0.3, right: near-sync to trunk
- kindly provided by
Preparing the plugin from source requires no additional steps for compiling message catalog files. Only to include translations marked as # fuzzy
by the translator, you'll want to do a manual message catalog compilation with the extra -f
argument before packaging:
cd accountmanagerplugin/ python ./setup.py compile_catalog -f python ./setup.py bdist_egg
Complaints about missing locale
directory are often a side-effect of failure to compile any message catalog for inclusion into Python egg, hence the whole path is missing. Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.
Again, for more details see the l10n cookbook page for Trac plugins.
Setup
Components
In order to use the features of the AccountManager you will need to enable some or all of its components. The available components are mentioned here, but are described in greater details on separate pages linked below.
Component | Description/Purpose | Recommendation |
AccountManager | This holds core code of this plugin. | This component must be enabled to use any of the other components. See details. |
AccountManagerAdminPanel1 | This component adds new pages to the web admin section. | The admin part for managing related parts of Trac's configuration2 should be an important part of what you're expecting. See details. |
AccountModule | Allows users to manage their account3 via tab “Account” in users “Preferences”. | The user accessible part, might be required or even forbidden depending on your use case. See details. |
LoginModule | Allows users to login via a HTML form instead of using HTTP authentication. | Replace Trac's own login module for an alternative to Simple HTTP Authentication, but only one can be enable at a time. See details. |
AccountGuard | This component adds login failure tracking and administrative account locking. | Use it as part of your security policy to protect against brute-force attacks on user passwords. See details. |
RegistrationModule | It adds a “Register” link on metanav4. | Enable users to register a new account with a configurable procedure. See details. |
EmailVerificationModule | An new email address will trigger an email with a verification code to enter, to approve it is really users own email address, and user account privileges cut down until successful verification. | Implement a verification process for added or changed email addresses, if required. See details. |
1 Name in acct_mgr-0.3 was AccountManagerAdminPage
. If you are upgrading to acct_mgr-0.4 from an earlier version, and this feature was enabled using acct_mgr.admin.AccountManagerAdminPages
, this feature will now be disabled until it is enabled using acct_mgr.admin.AccountManagerAdminPanel
.
2 Found in trac.ini
3 Change their password, or even delete their account, if permission granted by appropriate configuration
4 Same menu bar as the “Login” link
The easiest way to learn about available components and enable them is via Trac's plugin admin page (before Trac 0.11 this has been a separate trac:WebAdmin plugin). Users logged in with the TRAC_ADMIN permission will be able to manage the enabled components:
Components can also be enabled or disabled in the trac.ini file under the [components]
section.
Configuration
For examples of basic configurations and more see configuration cookbook.
Post Setup/Configuration
In order to use the AccountManager plugin, while logged in as a user owning TRAC_ADMIN
rights, use the “Admin” link on the menubar.
You might want to change some permission assignments. For instance, if you remove TICKET_MODIFY
and WIKI_MODIFY
permission from the “anonymous“ group and add it to the “authenticated” group instead, only authenticated, logged-in (registered) users can perform ticket modifications and wiki editing.
TRAC_ADMIN
is not strictly required for access to account administration pages provided by AccountManager. The ACCTMGR_*
permissions are sufficient, and should even be preferred where appropriate, i.e. to limit delegation of administrative tasks to just account administration by granting ACCTMGR_USER_ADMIN
.
Recent Changes
Author/Contributors
Author: mgood
Maintainer: hasienda
Contributors: coderanger, crocea, janakj, jun66j5, manski, mrelbe, otaku42, pacopablo, riggs, rjollos, s0undt3ch
Attachments (9)
-
components-admin.png (82.0 KB) - added by 18 years ago.
screenshot of components web admin
-
account-manager-admin.png (39.1 KB) - added by 18 years ago.
screenshot of account administration
-
login-form.png (4.4 KB) - added by 18 years ago.
screenshot of login form
-
register.png (5.6 KB) - added by 18 years ago.
screenshot of registration page
- my-account.png (7.5 KB) - added by 18 years ago.
- reset-password.png (8.2 KB) - added by 18 years ago.
-
account-manager-admin_v0.4.png (75.3 KB) - added by 13 years ago.
screenshot of account administration - v 0.4
-
transifex_acct_mgr-messages_v0.3.png (15.8 KB) - added by 13 years ago.
coverage of translations per language for v0.3
-
components-admin_acct_mgr-0.4.png (175.3 KB) - added by 11 years ago.
screenshot of components admin page - v0.4
Download all attachments as: .zip