FlexMeasures / flexmeasures / 42803193113
88%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 195
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 87.876%. Remained the same
42803193113

push

github

web-flow 
Bring the security and hosting docs in line with the current defaults (#2842)

* docs: bring the security and hosting pages in line with the current defaults

Context:
- #1008 (first released in v0.20.0) made the HTTPS redirect opt-in through FLEXMEASURES_FORCE_HTTPS, and #1564 (v0.27.0) turned two-factor authentication off by default, but the docs still described both as always on.
- The pages also described bcrypt password hashes, sha256_crypt tokens with a 2011 epoch, and SECURITY_TOKEN_MAX_AGE as an environment variable, while Flask-Security hashes with Argon2, itsdangerous signs the tokens with Unix timestamps, and that setting is only read from the config file.
- The Docker examples passed SECURITY_TOTP_SECRETS as unquoted JSON with a space, which the shell splits into two arguments, and it is not needed while 2FA is off.

Change:
- security_auth: HTTPS is set up by the host, FLEXMEASURES_FORCE_HTTPS adds the redirect, 2FA is supported and off by default, and the password and token details match the code.
- configuration: a label for FLEXMEASURES_FORCE_HTTPS, when it redirects, the Flask-SSLify settings that apply, and that it is read from the config file only.
- docker, installation: production mode needs no TLS; development mode is for your own computer; drop SECURITY_TOTP_SECRETS from the default commands; an example of a setting environment variables cannot set that is one; http:// for localhost links.
- api/introduction: http://localhost:5000/api for a local server.

Signed-off-by: Serhii <jshmitz@me.com>

* changelog: security and hosting documentation brought up to date

Context:
- Hosts read these pages to secure an installation, so the correction belongs in the changelog.

Change:
- Add it under Infrastructure / Support in v1.2.0, with a placeholder for the PR number.

Signed-off-by: Serhii <jshmitz@me.com>

* changelog: fill in the PR number

Context:
- The changelog entry was written before the pull request existed.

Change:
- Link it... (continued)

23267 of 26477 relevant lines covered (87.88%)

0.88 hits per line

Jobs
ID Job ID Ran Files Coverage
1 42803193113.1 195
87.88
GitHub Action Run
Source Files on build 42803193113