wassname/flask-security
1
0
Fork 0
mirror of https://github.com/wassname/flask-security.git synced 2026-09-12 12:21:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs. Fixes #137

Browse Source
This commit is contained in:
Matt Wright
2013-07-22 11:26:11 -04:00
parent 0f46f35981
commit 5e2a016bcd
1 changed files with 33 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration.rst
+33 -19
View File
@@ -56,6 +56,8 @@ URLs and Views
``/register``. ``/register``.
``SECURITY_RESET_URL`` Specifies the password reset URL. Defaults to ``SECURITY_RESET_URL`` Specifies the password reset URL. Defaults to
``/reset``. ``/reset``.
``SECURITY_CHANGE_URL`` Specifies the password change URL. Defaults to
``/change``.
``SECURITY_CONFIRM_URL`` Specifies the email confirmation URL. Defaults ``SECURITY_CONFIRM_URL`` Specifies the email confirmation URL. Defaults
to ``/confirm``. to ``/confirm``.
``SECURITY_POST_LOGIN_VIEW`` Specifies the default view to redirect to after ``SECURITY_POST_LOGIN_VIEW`` Specifies the default view to redirect to after
@@ -86,8 +88,14 @@ URLs and Views
successfully resets their password. This value successfully resets their password. This value
can be set to a URL or an endpoint name. If this can be set to a URL or an endpoint name. If this
value is ``None`` the user is redirected to the value is ``None`` the user is redirected to the
value of ``SECURITY_POST_LOGIN_VIEW``. Defaults to value of ``SECURITY_POST_LOGIN_VIEW``. Defaults
``None``. to ``None``.
``SECURITY_POST_CHANGE_VIEW`` Specifies the view to redirect to after a user
successfully changes their password. This value
can be set to a URL or an endpoint name. If this
value is ``None`` the user is redirected to the
value of ``SECURITY_POST_LOGIN_VIEW``. Defaults
to ``None``.
``SECURITY_UNAUTHORIZED_VIEW`` Specifies the view to redirect to if a user ``SECURITY_UNAUTHORIZED_VIEW`` Specifies the view to redirect to if a user
attempts to access a URL/endpoint that they do attempts to access a URL/endpoint that they do
not have permission to access. If this value is not have permission to access. If this value is
@@ -167,23 +175,29 @@ Email
.. tabularcolumns:: |p{6.5cm}|p{8.5cm}| .. tabularcolumns:: |p{6.5cm}|p{8.5cm}|
=========================================== ==================================== ================================================= ==============================
``SECURITY_EMAIL_SUBJECT_REGISTER`` Sets the subject for the ``SECURITY_EMAIL_SUBJECT_REGISTER`` Sets the subject for the
confirmation email. Defaults to confirmation email. Defaults
``Welcome`` to ``Welcome``
``SECURITY_EMAIL_SUBJECT_PASSWORDLESS`` Sets the subject for the ``SECURITY_EMAIL_SUBJECT_PASSWORDLESS`` Sets the subject for the
passwordless feature. Defaults to passwordless feature. Defaults
``Login instructions`` to ``Login instructions``
``SECURITY_EMAIL_SUBJECT_PASSWORD_NOTICE`` Sets subject for the password ``SECURITY_EMAIL_SUBJECT_PASSWORD_NOTICE`` Sets subject for the password
notice. Defaults to notice. Defaults to ``Your
``Your password has been reset`` password has been reset``
``SECURITY_EMAIL_SUBJECT_PASSWORD_RESET`` Sets the subject for the password ``SECURITY_EMAIL_SUBJECT_PASSWORD_RESET`` Sets the subject for the
reset. Defaults to password reset email. Defaults
``Password reset instructions`` to ``Password reset
``SECURITY_EMAIL_SUBJECT_CONFIRM`` Sets the subject for the email instructions``
confirmation message. Defaults to ``SECURITY_EMAIL_SUBJECT_PASSWORD_CHANGE_NOTICE`` Sets the subject for the
``Please confirm your email`` password change notice.
=========================================== ==================================== Defaults to ``Your password
has been changed``
``SECURITY_EMAIL_SUBJECT_CONFIRM`` Sets the subject for the email
confirmation message. Defaults
to ``Please confirm your
email``
================================================= ==============================
Miscellaneous Miscellaneous
------------- -------------