Skip to content

Commit

Permalink
Fix user docs in README
Browse files Browse the repository at this point in the history
Signed-off-by: David Cassany <[email protected]>
  • Loading branch information
davidcassany committed Oct 21, 2024
1 parent d482c98 commit 06805cd
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,13 +330,14 @@ In case the user is already existing, the password only will be overwritten.
- **gecos**: GECOS comment of user
- **passwd**: Hash of the password to use for this user. Unencrypted strings supported too.
- **homedir**: User's home directory. Defaults to /home/*name*
- **no-create-home**: Boolean. Skip home directory creation.
- **primary-group**: Default group for the user. Defaults to a new group created named after the user.
- **no_create_home**: Boolean. Skip home directory creation.
- **primary_group**: Default group for the user. Defaults to a new group created named after the user.
- **groups**: Add user to these additional groups
- **no-user-group**: Boolean. Skip default group creation.
- **ssh-authorized-keys**: List of public SSH keys to authorize for this user
- **no_user_group**: Boolean. Skip default group creation.
- **ssh_authorized_keys**: List of public SSH keys to authorize for this user
- **system**: Create the user as a system user. No home directory will be created.
- **no-log-init**: Boolean. Skip initialization of lastlog and faillog databases.
- **no_log_init**: Boolean. Skip initialization of lastlog and faillog databases.
- **lock_passwd**: Boolean. Locks password for the user.
- **shell**: User's login shell.

```yaml
Expand All @@ -346,7 +347,7 @@ stages:
users:
bastion:
passwd: "strongpassword"
homedir: "/home/foo
homedir: "/home/foo"
```

### `stages.<stageID>.[<stepN>].ensure_entities`
Expand Down

0 comments on commit 06805cd

Please sign in to comment.