Skip to content

Commit 21998df

Browse files
committed
docs: add single user mode documentation
1 parent 2581ede commit 21998df

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ With this role you can:
99
* Create system administrator users
1010
* Remove system administrator users
1111
* Add `sudo` permissions to system administrator users
12+
* Add multiple ssh keys to a single system administrator user
1213

1314
This role need be runned with `sudo` access.
1415

@@ -41,11 +42,24 @@ System Administrators vars:
4142

4243
### `sys_admin_group`
4344

44-
The name of the system adnimistrators group
45+
The name of the system administrators group
4546

4647
```yaml
4748
sys_admin_group: sysadmin-group
4849
```
50+
51+
## Single user mode
52+
When you are restricted to a single user, you must set the `sysadmin_multi_user` variable to `false` and set the `sysadmin_user` variable with the user name. The user must be already created on the server with root privileges.
53+
54+
This will iterate over the `sys_admins` list and add each user key to the authorized keys for the user defined in `sysadmin_user` variable.
55+
56+
This mode is disabled by default.
57+
58+
```yaml
59+
sysadmin_multi_user: false
60+
sysadmin_user: "sysadmin"
61+
```
62+
4963
Example Playbook
5064
----------------
5165

0 commit comments

Comments
 (0)