diff --git a/docs/configuration.rst b/docs/configuration.rst index bc72984f..b014cc02 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -40,10 +40,8 @@ Core ``bcrypt``, ``sha512_crypt``, or ``pbkdf2_sha512``. Defaults to ``bcrypt``. -``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_PASSWORD_SALT`` Specifies the HMAC salt. Defaults to + ``None``. ``SECURITY_PASSWORD_SINGLE_HASH`` Specifies that passwords should only be hashed once. By default, passwords are hashed twice, first with diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 3b215edc..00d128d8 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -40,6 +40,8 @@ possible using SQLAlchemy: app.config['DEBUG'] = True app.config['SECRET_KEY'] = 'super-secret' app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite://' + # Bcrypt is set as default SECURITY_PASSWORD_HASH, which requires a salt + app.config['SECURITY_PASSWORD_SALT'] = 'super-secret-random-salt' # Create database connection object db = SQLAlchemy(app) @@ -233,6 +235,8 @@ possible using MongoEngine: app = Flask(__name__) app.config['DEBUG'] = True app.config['SECRET_KEY'] = 'super-secret' + # Bcrypt is set as default SECURITY_PASSWORD_HASH, which requires a salt + app.config['SECURITY_PASSWORD_SALT'] = 'super-secret-random-salt' # MongoDB Config app.config['MONGODB_DB'] = 'mydatabase' @@ -307,6 +311,8 @@ possible using Peewee: 'name': 'example.db', 'engine': 'peewee.SqliteDatabase', } + # Bcrypt is set as default SECURITY_PASSWORD_HASH, which requires a salt + app.config['SECURITY_PASSWORD_SALT'] = 'super-secret-random-salt' # Create database connection object db = Database(app)