Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs improvements #5

Merged
merged 2 commits into from
Sep 10, 2024
Merged

Docs improvements #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1f251b
changelog: init
nikstur Sep 10, 2024
fb4d715
readme: idempotence -> nondestructivity
nikstur Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

## 0.2.0 (unreleased)

- /etc/{group,passwd,shadow} are now sorted by GID/UID. This follows the
behaviour of systemd-sysusers, update-users-groups.pl and generally what the
shadow package does, most notably `pwck --sort`.
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Userborn is available in Nixpkgs (nixos-unstable). To enable it:
services.userborn.enable = true;
```

### Idempotence
## Nondestructivity

- Never deletes a user or group, only disables them when they are not present
in the config anymore.
Expand All @@ -46,7 +46,7 @@ re-use is best illustrated by an example. Imagine the following scenario:
- This user can now access files from a previously existing user because their
UIDs are the same.

Limitations:
### Limitations to Nondestructivity

- When you provide a plaintext password in the config (which you really
shouldn't!), the hashed password is updated each time userborn runs. This can
Expand All @@ -56,6 +56,11 @@ Limitations:
in plaintext!) and it will only suppress a single log line.
- Userborn can handle comments in the password database files but it will
silently discard them.
- Userborn will sort the password database files by GID/UID. This influences
only the representation inside the text files but doesn't change the way
group/user resolution works.
- Userborn will discard entries in the shadow database that are not present in
the passwd database. It will warn about these inconsistent entries.

## Comparison With Other Tools for Declarative User Management

Expand Down