view release on metacpan or  search on metacpan

README  view on Meta::CPAN

            the heading at the top of the login box

        USERNAME_LABEL (default: User Name)
            the label for the user name input

        PASSWORD_LABEL (default: Password)
            the label for the password input

        SUBMIT_LABEL (default: Sign In)
            the label for the submit button

        COMMENT (default: Please enter your username and password in the
        fields below.)
            a message provided on the first login attempt

        REMEMBERUSER_OPTION (default: 1)
            provide a checkbox to offer to remember the users name in a
            cookie so that their user name will be pre-filled the next time
            they log in

        REMEMBERUSER_LABEL (default: Remember User Name)
            the label for the remember user name checkbox

        REMEMBERUSER_COOKIENAME (default: CAPAUTHTOKEN)
            the name of the cookie where the user name will be saved

        REGISTER_URL (default: <none>)
            the URL for the register new account link

        REGISTER_LABEL (default: Register Now!)
            the label for the register new account link

        FORGOTPASSWORD_URL (default: <none>)
            the URL for the forgot password link

        FORGOTPASSWORD_LABEL (default: Forgot Password?)
            the label for the forgot password link

        INVALIDPASSWORD_MESSAGE (default: Invalid username or password<br
        />(login attempt %d)
            a message given when a login failed

        INCLUDE_STYLESHEET (default: 1)
            use this to disable the built in style-sheet for the login box
            so you can provide your own custom styles

        FORM_SUBMIT_METHOD (default: post)
            use this to get the form to submit using 'get' instead of 'post'

        FOCUS_FORM_ONLOAD (default: 1)
            use this to automatically focus the login form when the page
            loads so a user can start typing right away.

        BASE_COLOUR (default: #445588)
            This is the base colour that will be used in the included login
            box. All other colours are automatically calculated based on
            this colour (unless you hardcode the colour values). In order to
            calculate other colours, you will need the Color::Calc module.
            If you do not have the Color::Calc module, then you will need to
            use fixed values for all of the colour options. All colour
            values besides the BASE_COLOUR can be simple percentage values
            (including the % sign). For example if you set the
            LIGHTER_COLOUR option to 80%, then the calculated colour will be
            80% lighter than the BASE_COLOUR.

        LIGHT_COLOUR (default: 50% or #a2aac4)
            A colour that is lighter than the base colour.

        LIGHTER_COLOUR (default: 75% or #d0d5e1)
            A colour that is another step lighter than the light colour.

        DARK_COLOUR (default: 30% or #303c5f)
            A colour that is darker than the base colour.

        DARKER_COLOUR (default: 60% or #1b2236)
            A colour that is another step darker than the dark colour.

        GREY_COLOUR (default: #565656)
            A grey colour that is calculated by desaturating the base
            colour.

  protected_runmodes
    This method takes a list of runmodes that are to be protected by
    authentication. If a user tries to access one of these runmodes, then
    they will be redirected to a login page unless they are properly logged
    in. The runmode names can be a list of simple strings, regular
    expressions, or special directives that start with a colon. This method
    is cumulative, so if it is called multiple times, the new values are
    added to existing entries. It returns a list of all entries that have
    been saved so far. Calling this function, will not itself generate
    cookies or session ids.

    :all - All runmodes in this module will require authentication

      # match all runmodes
      __PACKAGE__->authen->protected_runmodes(':all');

      # only protect runmodes one two and three
      __PACKAGE__->authen->protected_runmodes(qw(one two three));

      # protect only runmodes that start with auth_
      __PACKAGE__->authen->protected_runmodes(qr/^auth_/);

      # protect all runmodes that *do not* start with public_
      __PACKAGE__->authen->protected_runmodes(qr/^(?!public_)/);

  is_protected_runmode
    This method accepts the name of a runmode, and will tell you if that
    runmode is a protected runmode (i.e. does a user need to be
    authenticated to access this runmode). Calling this function, will not
    itself generate cookies or session ids.

  redirect_after_login
    This method is be called during the prerun stage to redirect the user to
    the page that has been configured as the destination after a successful
    login. The location is determined as follows:

    POST_LOGIN_RUNMODE
        If the POST_LOGIN_RUNMODE config parameter is set, that run mode
        will be the chosen location.