From bf9523fba1bf27e96ac054d195e44076382b0686 Mon Sep 17 00:00:00 2001
From: Alexander Karl <akarl@darknebu.la>
Date: Thu, 10 Oct 2019 22:25:18 +0200
Subject: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ecdbf2e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+## Static Filehost
+- Container is build to host static files from defined path
+- Can be used with subpath
+- Ignores requests to /
+### Use Container
+#### Docker run
+docker run -it --rm -p 8080:8080 -e port=8080 -e dir=/lul -e subpath="fump" -v /tmp/:/lul registry.darknebu.la/circus/static
+#### Docker compose
+services: 
+  static_files:
+    image: registry.darknebu.la/circus/static
+    environment: 
+      - "dir=/content"
+      - "port=8080"
+      - "subpath=fump"
+    ports: 
+      - "8080:8080"
+    volumes: 
+      - "/tmp/:/content"
+    restart: unless-stopped
-- 
cgit 1.4.1