From c5bf7382914393a0f8fd6eefbea39f5f4aa9472f Mon Sep 17 00:00:00 2001
From: Andrew Davidson <andrew@amdavidson.com>
Date: Tue, 14 Apr 2020 08:52:10 -0400
Subject: [PATCH] Adding readme

---
 Readme.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..23231a9
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,27 @@
+# samba-server
+
+A basic single user samba-server suitable for small scale NAS-like installations where having multi-user security is not important.
+
+## Running Samba Server
+
+No real tricks here, the only essential thing is setting a password in the environment vars
+
+To do so with a docker-compose file:
+
+```yaml
+version: "2"
+
+services:
+    samba:
+        image: amdavidson/samba-server 
+        restart: always
+        environment:
+            SMBPW: "Hunter22"
+        ports:
+            - "139:139"
+            - "445:445"
+            - "138:138/udp"
+            - "137:137/udp"
+        volumes:
+            - "/host/share/folder:/share"
+```