From 5ea4838d19ab9d51c1390b37cc0e04e2aefb8cca Mon Sep 17 00:00:00 2001 From: Pierre Dubouilh Date: Sun, 28 Jun 2020 12:48:34 +0200 Subject: [PATCH 1/3] bump ui --- gossa-ui | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gossa-ui b/gossa-ui index db5c18c..1d42db2 160000 --- a/gossa-ui +++ b/gossa-ui @@ -1 +1 @@ -Subproject commit db5c18c923dc9faba4b5e7fab5d7c9dc1ee29da1 +Subproject commit 1d42db2870dbefc65581d0500409ef416d778454 From c7e92cb73052d8ce2ed0e72d621603536a64a671 Mon Sep 17 00:00:00 2001 From: Pierre Dubouilh Date: Sun, 28 Jun 2020 12:49:03 +0200 Subject: [PATCH 2/3] add install instructions to makefile --- Makefile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Makefile b/Makefile index 063183e..02f9d05 100755 --- a/Makefile +++ b/Makefile @@ -5,6 +5,9 @@ build: CGO_ENABLED=0 go build gossa.go rm gossa.go +install: + sudo cp gossa /usr/local/bin + run: ./gossa -verb=true test-fixture From 56f418bbfff95c004d0c039a4936e50a7cc5a139 Mon Sep 17 00:00:00 2001 From: Pierre Dubouilh Date: Sun, 28 Jun 2020 13:08:02 +0200 Subject: [PATCH 3/3] reword readme --- readme.md | 2 +- support/readme.md | 49 ++++++++++++++++++++++++----------------------- 2 files changed, 26 insertions(+), 25 deletions(-) diff --git a/readme.md b/readme.md index 5954bc2..21d8240 100644 --- a/readme.md +++ b/readme.md @@ -41,7 +41,7 @@ release images are pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gos % sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa ``` -in a do-one-thing-well mindset, HTTPS and authentication has been left to middlewares and proxies. [this sample caddy config](https://github.com/pldubouilh/gossa/blob/master/support/) shows how to quickly get a multi user setup along with https. +in a do-one-thing-well mindset, HTTPS and authentication has been left to middlewares and proxies. [sample caddy configs](https://github.com/pldubouilh/gossa/blob/master/support/) are available to quickly setup multi users setups along with https. ### shortcuts the default UI is fully usable by through keyboard/UI shortcuts - press `Ctrl/Cmd + h` to see them all. diff --git a/support/readme.md b/support/readme.md index 7620e2f..3aa348e 100644 --- a/support/readme.md +++ b/support/readme.md @@ -1,6 +1,30 @@ +## docker + +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 +% mkdir ~/LocalDirToShare +% sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa + +# options are settable through env. variabes. all the options are the build.Dockerfile +% sudo docker run -e PREFIX="/gossa/" -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, and run +% mkdir ~/LocalDirToShare +% docker build -t gossa -f support/build.Dockerfile . +% sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 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. + ## multi-account setup -authentication / user routing has been left out of the design of gossa, as simple tools are already available for this purpose. +authentication / user routing has been left out of the design of gossa, as simple tools are already available for this purpose. [caddy](https://caddyserver.com/v1/) is used here as an example, but other proxy can be used in a similar fashion. ### example 1 root, multiple read-only users @@ -84,26 +108,3 @@ start 2 gossa instances, and caddy % ./gossa -p 8002 -symlinks=true test/user2 & % ./caddy ``` - -## docker - -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 -% mkdir ~/LocalDirToShare -% 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, and run -% docker build -t gossa -f support/build.Dockerfile . -% mkdir ~/LocalDirToShare -% sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 gossa -``` - -the options are settable through environment variables that can be passed starting off the docker image. - -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