init

README.md

@@ -0,0 +1,31 @@
+*nixnutz* - removing abandoned user data everywhere.
+
+# Overview
+
+Maintaining a lot of services with a shared user database (e.g. LDAP) requires a clean off-boarding procedure.
+When (not if) a user decides to leave, all their data should be removed from all related services.
+
+This tool is supposed to help administrators to maintain the clean state of their flock (services).
+
+# Usage
+
+1. Configure your global *single point of truth*.
+    * This is your common source of all real accounts, e.g. LDAP.
+1. Configure the source of local derived accounts (e.g. via SQL, API, command, ...).
+    1. Configure one or more "removal" actions.
+1. Let the "cleanup" operation remove abandoned user data from each of your services.
+
+Configuration is parsed from a [yaml](https://yaml.org/) file.
+
+Periodic operation can be scheduled via `cron`, `systemd.timer` or any other similar tool.
+
+# Installation
+
+```shell
+pipx install hatch
+hatch run nixnutz --help
+```
+
+## License
+
+`nixnutz` is distributed under the terms of the [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) license.