docs: update user onboarding guide

This commit is contained in:
Khue Doan 2024-01-06 02:11:20 +07:00
parent a5c8f1e9c5
commit 09ce3e64fc
3 changed files with 12 additions and 13 deletions

View File

@ -55,7 +55,7 @@ More information can be found in [the roadmap](#roadmap) below.
- [x] Support multiple environments (dev, prod) - [x] Support multiple environments (dev, prod)
- [ ] Monitoring and alerting 🚧 - [ ] Monitoring and alerting 🚧
- [ ] Automated offsite backups 🚧 - [ ] Automated offsite backups 🚧
- [ ] Single sign-on 🚧 - [x] Single sign-on
- [x] Infrastructure testing - [x] Infrastructure testing
Some demo videos and screenshots are shown here. 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
<td><a href="https://k3s.io">K3s</a></td> <td><a href="https://k3s.io">K3s</a></td>
<td>Lightweight distribution of Kubernetes</td> <td>Lightweight distribution of Kubernetes</td>
</tr> </tr>
<tr>
<td><img width="32" src="https://kanidm.com/images/logo.svg"></td>
<td><a href="https://kanidm.com">Kanidm</a></td>
<td>Modern and simple identity management platform</td>
</tr>
<tr> <tr>
<td><img width="32" src="https://avatars.githubusercontent.com/u/13629408"></td> <td><img width="32" src="https://avatars.githubusercontent.com/u/13629408"></td>
<td><a href="https://kubernetes.io">Kubernetes</a></td> <td><a href="https://kubernetes.io">Kubernetes</a></td>

View File

@ -24,19 +24,13 @@
=== "For admin" === "For admin"
## Create a new account Run the following script:
TODO ```sh
./script/onboard-user exampleuser "Example User" "user@example.com"
```
## Send initial password Let the user scan the QR code or follow the link to set up passkeys or password + TOTP.
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.
## Appendix ## Appendix

View File

@ -23,7 +23,7 @@ Good enough for tinkering and personal usage, and reasonably secure.
- [x] Monitoring - [x] Monitoring
- [x] Logging - [x] Logging
- [ ] Alerting - [ ] Alerting
- [ ] SSO - [x] SSO
- [ ] Reasonably secure - [ ] Reasonably secure
- [x] Automated certificate management - [x] Automated certificate management
- [x] Declarative secret management - [x] Declarative secret management