maintain state

support/readme.md

@@ -0,0 +1,29 @@
+the master branch is automatically built and pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gossa) under `pldubouilh/gossa`.
+
+```sh
+# pull from dockerhub and run
+% sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa
+```
+
+if you prefer building the image yourself :
+
+```sh
+# build gossa within a build container, needs to be ran within the sources, ../ from here
+% docker build -t gossa -f support/build.Dockerfile .
+
+# and to run it simply
+% sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 gossa
+```
+
+
+a fancy docker image using [Caddy](https://caddyserver.com/) is also provided. a simple config is embedded in the docker file, and shows how to use http basic authentication, and automatic TLS for hands-free https 🎉
+
+```sh
+# run with caddy, checkout the config in the dockerfile
+% docker build -t gossa-caddy -f caddy.Dockerfile .
+
+# run with caddy
+% sudo docker run -v ~/LocalDirToShare:/shared --net=host gossa-caddy
+```
+
+a docker-compose example image is also provided. running docker compose should be straightforward : `docker-compose up .` have a look in `docker-compose.yml` for further configuration.