diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml new file mode 100644 index 0000000..9101dbb --- /dev/null +++ b/docker/docker-compose.yml @@ -0,0 +1,16 @@ +version: '2' + +services: + gossa-server: + image: pldubouilh/gossa + container_name: gossa + restart: always + ports: + - 8001:8001 + volumes: + - ~/to-share:/shared +# labels: +# - "traefik.enable=true" +# - "traefik.port=8001" +# - "traefik.backend=gossa" +# - "traefik.frontend.rule=Host:${GOSSA}.${DOMAIN}" diff --git a/docker/readme.md b/docker/readme.md index 25cb0ed..9681d7d 100644 --- a/docker/readme.md +++ b/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. \ No newline at end of file diff --git a/readme.md b/readme.md index 2f59cf7..e96b66c 100644 --- a/readme.md +++ b/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,13 +53,9 @@ make |\ | 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 +# pull from dockerhub and run +sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa ```