commit 4622092c083337a2469bb23e44a76b182ba3ed48
Author: Glenn <glenux@glenux.net>
Date:   Thu Jan 12 19:56:15 2023 +0100

    Initial import

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c6e673
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+
+# Ntfy SSH Access
+
+Notify when users are signing on your servers via SSH.
+(WORK IN PROGRESS: do not use in production)
+ 
+## Roadmap
+
+* :x: setup VM for testing
+* :x: write template for script
+* :x: install script to host
+* :x: write test for script
+* :x: update PAM config
+* :x: write tests for PAM config
+
+## Variables defaults
+
+    ntfy_ssh_access.host: "https://ntfy.sh"                 # string, optional
+    ntfy_ssh_access.channel: ""                             # string, required
+    ntfy_ssh_access.username: ""                            # string, optional
+    ntfy_ssh_access.password: ""                            # string, optional
+    ntfy_ssh_access.ruser_ignore: ""                        # string, optional
+    ntfy_ssh_access.rhost_ignore: ""                        # string, optional
+    ntfy_ssh_access.title: "SSH login"                      # string, optional
+    ntfy_ssh_access.tags: "warning"                         # string, optional
+    ntfy_ssh_access.message: "USER@HOSTNAME from RHOST"     # string, optional
+    ntfy_ssh_access.script_path: /usr/sbin/ntfy-ssh-access  # string, optional
+    ntfy_ssh_access.pam_config_path: /etc/pam/sshd          # string, optional
+