improve docs

2021-11-08 01:33:13 +02:00
parent 10a6c9e12b
commit 7d104e8efc
3 changed files with 33 additions and 24 deletions
--- a/docs/users.md
+++ b/docs/users.md
@@ -0,0 +1,16 @@
+---
+
+Creates users specified in the `users` variable. Syntax:
+
+```
+users:
+  - name: username
+    password: hashed password
+    ssh_pubkey: 'ssh-rsa...'
+  - name: 'user1'
+    password: '$6$...'
+    ssh_pubkey: 'ssh-ed25519...'
+    shell: '/usr/bin/fish'
+```
+
+Specifying `shell` is optional