readme cleanup

docker/docker-compose.yml

@@ -2,20 +2,15 @@ version: '2'
 
 services:
   gossa-server:
-#    build: .
-    image: pldubouilh/gossa:v0.0.6
+    image: pldubouilh/gossa
     container_name: gossa
     restart: always
     ports:
       - 8001:8001
     volumes:
-#      - '${STORAGE}/gossa:/shared'
-      - gossa-server:/shared
+      - ~/to-share:/shared
 #    labels:
 #      - "traefik.enable=true"
 #      - "traefik.port=8001"
 #      - "traefik.backend=gossa"
 #      - "traefik.frontend.rule=Host:${GOSSA}.${DOMAIN}"
-
-volumes:
-  gossa-server: {}

docker/readme.md

@@ -1,8 +1,14 @@
-```sh
-# download latest gossa release
-docker build -t gossa -f download.Dockerfile .
+the master branch is automatically built and pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gossa) under `pldubouilh/gossa`.
 
-# ... or build gossa within a build container, needs to be ran within the sources, ../ from here
+```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 docker/build.Dockerfile .
 
 # and to run it simply
@@ -20,3 +26,4 @@ docker build -t gossa -f caddy.Dockerfile .
 sudo docker run -v ~/LocalDirToShare:/shared --net=host gossa
 ```
 
+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.

readme.md

@@ -9,7 +9,7 @@ gossa
 
 ### features
   * 🔍 files/directories browser
-  * 📩 drag-and-drop file uploader
+  * 📩 drag-and-drop file/directory uploader
   * 🗺️ files handling - move/rename/delete
   * 📸 picture browser
   * 📽️ video streaming from the browser
@@ -53,31 +53,9 @@ make
 |\<any letter\> | search|
 
 ### using with docker
-multiple dockerfiles are provided in the `docker` folder. to simply get started just have a look below
+a few docker/docker-compose files are provided in the [docker folder](https://github.com/pldubouilh/gossa/tree/master/docker). release images are also pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gossa), e.g. :
 
 ```sh
-# build
-cd docker
-docker build -t gossa -f download .
-
-# run
-sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 gossa
-```
-
-### docker-compose
-```
-version: '2'
-
-services:
-  gossa:
-    image: pldubouilh/gossa:v0.0.6
-    container_name: gossa
-    restart: always
-    ports:
-      - 8001:8001
-    volumes:
-      - gossa:/shared
-
-volumes:
-  gossa: {}
+# pull from dockerhub and run
+sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa
 ```