Update docs a bit

This commit is contained in:
Matt Wright
2012-08-24 00:48:14 -04:00
parent 4e41f4ec5e
commit da9f683c22
2 changed files with 17 additions and 22 deletions
+4 -9
View File
@@ -24,15 +24,10 @@ Core
production systems are ``bcrypt``,
``sha512_crypt``, or ``pbkdf2_sha512``.
Defaults to ``plaintext``.
``SECURITY_PASSWORD_HMAC`` Specifies if Flask-Security should also
use HMAC when encrypting and decrypting
passwords. If set to ``True`` be sure
to specify a salt value via the
``SECURITY_PASSWORD_HMAC_SALT``
configuration option. Defaults to
``False``.
``SECURITY_PASSWORD_HMAC_SALT`` Specifies the HMAC salt. Defaults to
``None``.
``SECURITY_PASSWORD_SALT`` Specifies the HMAC salt. This is only
used if the password hash type is set
to something other than plain text.
Defaults to ``None``.
``SECURITY_EMAIL_SENDER`` Specifies the email address to send
emails as. Defaults to
``no-reply@localhost``.
+13 -13
View File
@@ -10,16 +10,16 @@ and `Role` model should include the following fields:
**User**
* id
* email
* password
* active
* ``id``
* ``email``
* ``password``
* ``active``
**Role**
* id
* name
* description
* ``id``
* ``name``
* ``description``
Additional Functionality
@@ -35,7 +35,7 @@ If you enable account confirmation by setting your application's
`SECURITY_CONFIRMABLE` configuration value to `True` your `User` model will
require the following additional field:
* confirmed_at
* ``confirmed_at``
Trackable
^^^^^^^^^
@@ -44,8 +44,8 @@ If you enable user tracking by setting your application's `SECURITY_TRACKABLE`
configuration value to `True` your `User` model will require the following
additional fields:
* last_login_at
* current_login_at
* last_login_ip
* current_login_ip
* login_count
* ``last_login_at``
* ``current_login_at``
* ``last_login_ip``
* ``current_login_ip``
* ``login_count``