hedgedoc/docs/content/references/config/auth/local.md
Erik Michelson 7f665fae4b
Some checks are pending
Docker / build-and-push (frontend) (push) Waiting to run
Docker / build-and-push (backend) (push) Waiting to run
Deploy HD2 docs to Netlify / Deploys to netlify (push) Waiting to run
E2E Tests / backend-sqlite (push) Waiting to run
E2E Tests / backend-mariadb (push) Waiting to run
E2E Tests / backend-postgres (push) Waiting to run
E2E Tests / Build test build of frontend (push) Waiting to run
E2E Tests / frontend-cypress (1) (push) Blocked by required conditions
E2E Tests / frontend-cypress (2) (push) Blocked by required conditions
E2E Tests / frontend-cypress (3) (push) Blocked by required conditions
Lint and check format / Lint files and check formatting (push) Waiting to run
REUSE Compliance Check / reuse (push) Waiting to run
Scorecard supply-chain security / Scorecard analysis (push) Waiting to run
Static Analysis / Njsscan code scanning (push) Waiting to run
Static Analysis / CodeQL analysis (push) Waiting to run
Run tests & build / Test and build with NodeJS 20 (push) Waiting to run
feat(auth): refactor auth, add oidc
Thanks to all HedgeDoc team members for the time discussing,
helping with weird Nest issues, providing feedback
and suggestions!

Co-authored-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2024-09-11 21:29:49 +02:00

2.2 KiB

Local

HedgeDoc provides local accounts, handled internally. This feature only provides basic functionality, so for most environments, we recommend using an external authentication mechanism, which also enables more secure authentication like 2FA or Passkeys.

environment variable default example description
HD_AUTH_LOCAL_ENABLE_LOGIN false true, false This makes it possible to use the local accounts in HedgeDoc.
HD_AUTH_LOCAL_ENABLE_REGISTER false true, false This makes it possible to register new local accounts in HedgeDoc.
HD_AUTH_LOCAL_MINIMAL_PASSWORD_STRENGTH 2 0, 1, 2, 3, 4 The minimum password score, that passwords need to have. See the table below for more explanations.

Password score

The password score is calculated with zxcvbn-ts.

score meaning minimum number of guesses required (approximated)
0 All passwords with minimum 6 characters are allowed -
1 Only too guessable passwords are disallowed 1.000
2 too guessable and very guessable passwords are disallowed 1.000.000
3 safely unguessable and very unguessable passwords are allowed 100.000.000
4 Only very unguessable passwords are allowed 10.000.000.000