Changes between Version 8 and Version 9 of AccountManagerPlugin/RegistrationInspector


Ignore:
Timestamp:
Apr 3, 2016, 10:01:41 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • AccountManagerPlugin/RegistrationInspector

    v8 v9  
    1 [[PageOutline()]]
    2 = New User Registration =
     1[[PageOutline(2-5,Contents)]]
    32
    4 == Involved Modules ==
    5 In recent development the following modules have been moved from `web_ui` to their own place: `register`, and the required component activation changed accordingly.
     3= New User Registration
     4
     5== Involved Modules
     6
     7In the newest version the following modules have been moved from `web_ui` to their own place called `register` and the required component activation changed accordingly.
    68
    79For !AccountManager versions before `acct_mgr-0.4` use the following setting instead of the settings mentioned later on:
    8 {{{
    9 #!cfg
     10{{{#!ini
    1011[components]
    1112acct_mgr.web_ui.RegistrationModule = enabled
     
    1314}}}
    1415
    15 === !RegistrationModule ===
     16=== !RegistrationModule
     17
    1618 '''Package''':: acct_mgr.register
    1719
    18 Enables users to register a new account.  It adds a “Register” link on the same menu bar as the “Login” link.
     20Enables users to register a new account. It adds a "Register" link on the same menu bar as the "Login" link.
    1921
    2022[[Image(AccountManagerPlugin:register.png)]]
    2123
    22 ==== Configuration ====
    23 {{{
    24 #!cfg
     24==== Configuration
     25
     26{{{#!ini
    2527[components]
    2628acct_mgr.register.RegistrationModule = enabled
    2729}}}
    2830
    29 > '''Warning:''' You must enable one of the [wiki:AccountManagerPlugin/AuthStores password storage modules] for the Registration Module to work.
     31'''Warning:''' You must enable one of the [wiki:AccountManagerPlugin/AuthStores password storage modules] for the Registration Module to work.
    3032
    31 '''Note:''' You must not enable `ignore_auth_case` in `trac.ini` as otherwise this module won’t work. [''Update:'' This doesn't apply to `trunk` branch anymore. Use a revision at changeset [9286] or later to lift this limitation.]
     33'''Note:''' You must not enable `ignore_auth_case` in `trac.ini` as otherwise this module won't work. '''Update:''' This doesn't apply to `trunk` branch anymore. Use a revision at changeset [9286] or later to lift this limitation.
    3234
    33 === !EmailVerificationModule ===
     35=== !EmailVerificationModule
     36
    3437 '''Package''':: acct_mgr.register
    3538
    3639If you enable this, users will be sent an email with a verification code to enter, to approve it is really their own email address:
    3740
    38 ==== Configuration ====
    39 {{{
    40 #!cfg
     41==== Configuration
     42
     43{{{#!ini
    4144[components]
    4245acct_mgr.register.EmailVerificationModule = enabled
     
    4447}}}
    4548
    46 Until they entered the verification code on the URL sent with the email, their permissions will be restricted (even if they have the TRAC_ADMIN privilege, they won't be able to access anything exceeding the standard privileges of ''authenticated'' users). ''Update:'' After changeset [9304] ACCTMGR_ADMIN (and TRAC_ADMIN, as it inherits it among all other privileges) won't be bothered with the verification procedure.
     49Until they entered the verification code on the URL sent with the email, their permissions will be restricted. Even if they have the TRAC_ADMIN privilege, they won't be able to access anything exceeding the standard privileges of ''authenticated'' users. '''Update:''' After changeset [9304] ACCTMGR_ADMIN (and TRAC_ADMIN, as it inherits it among all other privileges) won't be bothered with the verification procedure.
    4750
    4851This '''has been added as a strict requirement now''' as suggested by ticket #5509 to `trunk` code with changeset [9277], but was not enforced before, so verification only happened, if an email had been specified on registration. In other words, if some user registered w/o specifying an email address, this was possible and an unrestricted account was created without requiring further actions.
    4952
    5053Note that if you don't want to enforce entering a valid email on registration, you may want to disable this component. An option
    51 {{{
    52 #!cfg
     54{{{#!ini
    5355[account-manager]
    5456verify_email = false
     
    5860As shown in the configuration above, you'll have to enable the accountchangelistener component as well. Without it, verification emails will be silently ignored (but the web-UI will still say they got sent!).
    5961
    60 == Modular Registration Checks ==
    61 === Configuration ===
     62== Modular Registration Checks
     63
     64=== Configuration
     65
    6266Since `acct_mgr-0.4` you have control over number and order of registration checks through an option in `trac.ini` (showing default value here):
    63 {{{
    64 #!cfg
     67{{{#!ini
    6568[account-manager]
    6669register_check = BasicCheck, EmailCheck, RegExpCheck, UsernamePermCheck
     
    7174To specify the regular expression against which email addresses are checked if !RegExpCheck was selected, use:
    7275
    73 {{{
    74 #!cfg
     76{{{#!ini
    7577[account-manager]
    7678email_regexp = your_regex
    7779}}}
    7880
    79 === Interface Definition ===
    80 {{{
    81 #!python
     81=== Interface Definition
     82
     83{{{#!python
    8284class IAccountRegistrationInspector(Interface):
    8385    """An interface for Components, that wish to participate in examining
     
    105107}}}
    106108
    107 === Related external resources ===
    108 There are some 3rd-party extensions to the registration module/process:
     109=== Related external resources
     110
     111There are some third-party extensions to the registration module/process:
    109112
    110113 * [wiki:GlobalRegisterPlugin GlobalRegisterPlugin] - no check, just adds a hint about user store being shared for all Trac environments at the same host
    111114 * [wiki:RecaptchaRegisterPlugin RecaptchaRegisterPlugin] - reCAPTCHA support for the registration page
    112  * [wiki:SimpleCaptchaPlugin SimpleCaptchaPlugin] - captcha driven by Skimpy Gimpy (uses an [wiki:RegistrationConfirmationPatch alternative extension point interface])
     115 * [wiki:SimpleCaptchaPlugin SimpleCaptchaPlugin] - captcha driven by Skimpy Gimpy; uses an [wiki:RegistrationConfirmationPatch alternative extension point interface]
    113116 * [wiki:TracCaptchaPlugin TracCaptchaPlugin] - modular reCAPTCHA support, not only for the registration page
    114117
    115118Related resources with different focus:
    116119 * [wiki:MathCaptchaPlugin MathCaptchaPlugin] - only for ticket edits and new ticket submission
    117  * [wiki:TracRecaptchaPlugin TracRecaptchaPlugin] - old (obsolete?) reCAPTCHA support, only for tickets