diff options
Diffstat (limited to 'roles/user/README.md')
| -rw-r--r-- | roles/user/README.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/roles/user/README.md b/roles/user/README.md index a1c66f12..e3f5360f 100644 --- a/roles/user/README.md +++ b/roles/user/README.md @@ -5,7 +5,8 @@ This role creates the user and configures the `sudo` group for the user ## Role Variables - `username` **Required** name of the user to be created. -- `user_password` created user default password (default: `changeme`). +- `user_default_password` default password (`changeme`) if used required to be changed on first `sudo` usage. +- `user_password` if provided, it will be used instead of the default password (and doesn't require change). - `user_login_shell` the path to default user login shell (default: `/bin/bash`) - `user_public_keys` the list of ssh public keys to be added to user authorized_keys - `user_groups` extra groups to be created and user added to them (default: []) @@ -15,7 +16,8 @@ This role creates the user and configures the `sudo` group for the user - ensure `sudo` installed. - configure `sudoers` file to grant `%sudo ALL=(ALL:ALL) ALL` for `sudo` group. - create user and add to the `username`, `sudo`, extra `user_groups` groups. -- require user password change on first use of `sudo` command. +- if `user_password` is provided, it's used as user password otherwise `user_default_password` is used. +- if `user_default_password` is used, it requires to be changed on first `sudo` usage. - configure the user authorized keys to allow public key authentication (if configured). ### Caveats |