From 1bab80f6b6500fc6839c4fa0023ab54e6e7d13d1 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Fri, 25 Nov 2022 23:55:25 +1100 Subject: [PATCH] docs: update (#4433) --- .../content/en/configuration/storage/migrations.md | 2 +- .../authelia_storage_user_totp_generate.md | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/content/en/configuration/storage/migrations.md b/docs/content/en/configuration/storage/migrations.md index 308976472..4d987ce92 100644 --- a/docs/content/en/configuration/storage/migrations.md +++ b/docs/content/en/configuration/storage/migrations.md @@ -28,7 +28,7 @@ this instance if you wanted to downgrade to pre1 you would need to use an Authel | Schema Version | Authelia Version | Notes | |:--------------:|:----------------:|:--------------------------------------------------------------------------------------------------:| -| pre1 | 4.0.0 | Downgrading to this version requires you use the --pre1 flag | +| pre1 | 4.0.0 | Downgrading to this version requires you use the --pre1 flag on Authelia 4.37.2 | | 1 | 4.33.0 | Initial migration managed version | | 2 | 4.34.0 | WebAuthn - added webauthn_devices table, altered totp_config to include device created/used dates | | 3 | 4.34.2 | WebAuthn - fix V2 migration kid column length and provide migration path for anyone on V2 | diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md index cbbafea4d..3d00321e2 100644 --- a/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md @@ -41,15 +41,15 @@ authelia storage user totp generate john --algorithm SHA512 --config config.yml ### Options ``` - --algorithm string set the TOTP algorithm (default "SHA1") - --digits uint set the TOTP digits (default 6) - -f, --force forces the TOTP configuration to be generated regardless if it exists or not + --algorithm string set the algorithm to either SHA1 (supported by most applications), SHA256, or SHA512 (default "SHA1") + --digits uint set the number of digits (default 6) + -f, --force forces the configuration to be generated regardless if it exists or not -h, --help help for generate - --issuer string set the TOTP issuer (default "Authelia") + --issuer string set the issuer description (default "Authelia") -p, --path string path to a file to create a PNG file with the QR code (optional) - --period uint set the TOTP period (default 30) - --secret string Optionally set the TOTP shared secret as base32 encoded bytes (no padding), it's recommended to not set this option unless you're restoring an TOTP config - --secret-size uint set the TOTP secret size (default 32) + --period uint set the period between rotations (default 30) + --secret string set the shared secret as base32 encoded bytes (no padding), it's recommended that you do not use this option unless you're restoring a configuration + --secret-size uint set the secret size (default 32) ``` ### Options inherited from parent commands