From 0edcbe5966bc59dcf44c4722a27953a1772cf8c3 Mon Sep 17 00:00:00 2001
From: neingeist <neingeist@bl0rg.net>
Date: Sun, 29 Jan 2023 01:28:27 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20add=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e095b5b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# docker-mod-openssh-server-tweaks
+
+A Docker mod for linuxserver.io's openssh-server Docker image
+
+This mod allows:
+
+- Tweaking the umask in `/etc/profile` (`TWEAK_PROFILE_UMASK`)
+- Tweaking the home directory of the user (`TWEAK_USER_HOME`)
+  (Note: You need to set up SSH keys etc. yourself if you use this.)
+- Tweaking the gid of the users group (`TWEAK_USERS_GID`)
+
+I use these tweaks to align my NAS defaults + my expectations with the
+settings inside an LSIO openssh-server container.
+
+## How to use
+
+For example, in a `docker-compose.yml` file:
+
+```
+# [...]
+services:
+  sshd-halde:
+    image: lscr.io/linuxserver/openssh-server:latest
+    # [...]
+    environment:
+      - DOCKER_MODS=ghcr.io/neingeist/docker-mod-openssh-server-tweaks
+      - TWEAK_PROFILE_UMASK=0002
+      - TWEAK_USER_HOME=/home/myuser
+      - TWEAK_USERS_GID=100
+# [...]
+```