Skip to content
This repository has been archived by the owner on Jul 30, 2024. It is now read-only.

Fix documentation for #781 #791

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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)
Expand Down