add readme HEAD master

1 files changed, 20 insertions, 0 deletions

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