From 09ce3e64fc2474ed1596e151e48f7f368a0ba6a1 Mon Sep 17 00:00:00 2001 From: Khue Doan Date: Sat, 6 Jan 2024 02:11:20 +0700 Subject: [PATCH] docs: update user onboarding guide --- README.md | 7 ++++++- docs/getting-started/user-onboarding.md | 16 +++++----------- docs/reference/roadmap.md | 2 +- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9ccba3bb..08c08007 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ More information can be found in [the roadmap](#roadmap) below. - [x] Support multiple environments (dev, prod) - [ ] Monitoring and alerting 🚧 - [ ] Automated offsite backups 🚧 -- [ ] Single sign-on 🚧 +- [x] Single sign-on - [x] Infrastructure testing Some demo videos and screenshots are shown here. @@ -165,6 +165,11 @@ They can't capture all the project's features, but they are sufficient to get a K3s Lightweight distribution of Kubernetes + + + Kanidm + Modern and simple identity management platform + Kubernetes diff --git a/docs/getting-started/user-onboarding.md b/docs/getting-started/user-onboarding.md index 6502db46..30eb1335 100644 --- a/docs/getting-started/user-onboarding.md +++ b/docs/getting-started/user-onboarding.md @@ -24,19 +24,13 @@ === "For admin" - ## Create a new account + Run the following script: - TODO + ```sh + ./script/onboard-user exampleuser "Example User" "user@example.com" + ``` - ## Send initial password - - Choose one of the methods listed below to send the initial password to the user: - - - Share via password manager (if supported) - - Encrypt the password file and send it via email or chat - - Simply write or print the password on a piece of paper - - On the first login, the user will be required to update their password. + Let the user scan the QR code or follow the link to set up passkeys or password + TOTP. ## Appendix diff --git a/docs/reference/roadmap.md b/docs/reference/roadmap.md index f7564362..90d6edee 100644 --- a/docs/reference/roadmap.md +++ b/docs/reference/roadmap.md @@ -23,7 +23,7 @@ Good enough for tinkering and personal usage, and reasonably secure. - [x] Monitoring - [x] Logging - [ ] Alerting -- [ ] SSO +- [x] SSO - [ ] Reasonably secure - [x] Automated certificate management - [x] Declarative secret management