refactor

.github/workflows/go.yml

@@ -1,4 +1,4 @@
-name: Go
+name: ci
 on: [push, pull_request]
 jobs:
 

.gitignore

@@ -8,6 +8,7 @@ gossa-windows.exe
 .vscode
 test-fixture/*
 test-fixture/*/*
+!test-fixture/.testhidden
 !test-fixture/compress
 !test-fixture/compress/foo*
 !test-fixture/gzip
@@ -36,3 +37,5 @@ test-fixture/*/*
 !test-fixture/hols/scotland-1761292_1920.jpg
 !test-fixture/fancy-path
 !test-fixture/fancy-path/*
+!test-fixture/ext/*
+!test-fixture/ext

.travis.yml

@@ -1,5 +0,0 @@
-language: go
-go:
-  - "1.10"
-script:
-  - make ci

Makefile

@@ -7,17 +7,17 @@ build:
 
 run:
 	make build
-	./gossa test-fixture
+	./gossa -verb=true test-fixture
 
 run-extra:
 	make build
-	./gossa -prefix="/fancy-path/" -symlinks=true test-fixture
+	./gossa -verb=true -prefix="/fancy-path/" -k=false -symlinks=true test-fixture
 
 ci:
-	-@cd test-fixture && ln -s ../docker .
+	-@cd test-fixture && ln -s ../support .
 	make build
-	timeout 10 make run &
+	timeout 15 make run &
-	sleep 11 && timeout 10 make run-extra &
+	sleep 16 && timeout 15 make run-extra &
 	cp src/gossa_test.go . && go test
 	rm gossa_test.go
 

docker/caddy.Dockerfile

@@ -1,22 +0,0 @@
-FROM alpine
-
-# download and prepare caddy
-RUN apk update && apk add curl ca-certificates
-RUN curl -L -o caddy.tar.gz "https://github.com/mholt/caddy/releases/download/v0.11.1/caddy_v0.11.1_linux_amd64.tar.gz"
-RUN tar xvzf caddy.tar.gz && mv caddy /caddy
-
-# download and prepare gossa
-RUN curl -L -o /gossa "https://github.com/pldubouilh/gossa/releases/download/v0.0.7/gossa-linux64"
-RUN chmod +x /gossa /caddy
-
-# Caddy config:
-# * http basic auth is implemented here, with bob as user and dylan as password
-# * to enable https just set a valid domain instead of *:8001 - how simple !
-RUN echo -e '\n\
-    *:8001\n\
-    basicauth / bob dylan\n\
-    proxy / 127.0.0.1:8000\n\
-'>> /Caddyfile
-
-RUN echo -e '/gossa -h 127.0.0.1 -p 8000 /shared & \n /caddy'>> /start.sh
-ENTRYPOINT [ "sh", "/start.sh" ]

docker/download.Dockerfile

@@ -1,10 +0,0 @@
-FROM alpine
-
-ENV UID="1000" GID="1000" HOST="0.0.0.0" PORT="8001" PREFIX="/" FOLLOW_SYMLINKS="false" SKIP_HIDDEN_FILES="true" DATADIR="/shared"
-EXPOSE 8001
-
-RUN apk add --no-cache su-exec
-RUN wget https://github.com/pldubouilh/gossa/releases/download/v0.0.8/gossa-linux64 && mv gossa-linux64 /gossa && chmod +x /gossa
-
-RUN echo -e 'exec su-exec ${UID}:${GID} /gossa -h ${HOST} -p ${PORT} -k=${SKIP_HIDDEN_FILES} --symlinks=${FOLLOW_SYMLINKS} --prefix=${PREFIX} ${DATADIR}'>> /start.sh
-ENTRYPOINT [ "sh", "/start.sh" ]

readme.md

@@ -1,9 +1,9 @@
 gossa
 =============
 
-![e](https://user-images.githubusercontent.com/760637/52522293-942fa880-2c83-11e9-9f79-0a5b922bcc7f.gif)
+![e](https://user-images.githubusercontent.com/760637/64541706-a3163080-d322-11e9-85ef-a4d8001fa6a5.gif)
 
-[![build status](https://img.shields.io/travis/pldubouilh/gossa.svg?logo=travis)](https://travis-ci.org/pldubouilh/gossa)
+[![build status](https://github.com/pldubouilh/gossa/workflows/ci/badge.svg)](https://github.com/pldubouilh/gossa/actions)
 [![docker build status](https://img.shields.io/docker/cloud/build/pldubouilh/gossa.svg?logo=docker)](https://hub.docker.com/r/pldubouilh/gossa)
 [![docker pulls](https://img.shields.io/docker/pulls/pldubouilh/gossa.svg?logo=docker)](https://hub.docker.com/r/pldubouilh/gossa)
 [![github downloads](https://img.shields.io/github/downloads/pldubouilh/gossa/total.svg?logo=github)](https://github.com/pldubouilh/gossa/releases)
@@ -16,13 +16,14 @@ a [simple UI](https://github.com/pldubouilh/gossa-ui) comes as default, featurin
   * 📩 drag-and-drop file/directory uploader
   * 🗺️ files handling - move/rename/delete
   * 📸 picture browser
-  * 📽️ video streaming from the browser
+  * 📽️ video streaming
   * ✍️ simple text editor
   * ⌨️ keyboard shortcuts
-  * 🥂 speed - showed rates above 100MB/s
+  * 🥂 speed - will easily fill available bandwidth
+  * 🔒 safe - easy/secure multi account setup
 
 ### build
-built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases) - or simply `make build` this repo
+built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases) - or simply `make build` this repo.
 
 ### usage
 ```sh
@@ -31,33 +32,16 @@ built blobs are available on the [release page](https://github.com/pldubouilh/go
 % ./gossa -h 192.168.100.33 ~/storage
 ```
 
-### ui shortcuts
+### fancier setups
-|shortcut | action|
+release images are pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gossa), e.g. :
-| ------------- |-------------|
-|click new folder icon | create new folder|
-|click pad icon | open file editor|
-|click file icon  | rename item|
-|double click file icon | delete item|
-|drag-and-drop item on UI | move item|
-|drag-and-drop external item | upload file/folders|
-
-### keyboard shortcuts
-|shortcut | action|
-|-------------|-------------|
-|Arrows/Enter | browse through files/directories and pictures|
-|Ctrl/Meta + C | copy URL to clipboard|
-|Ctrl/Meta + E | rename file/folder|
-|Ctrl/Meta + Del | delete file/folder|
-|Ctrl/Meta + U | upload new file/folder|
-|Ctrl/Meta + D | create a new directory|
-|Ctrl/Meta + X | cut selected path|
-|Ctrl/Meta + V | paste previously selected paths to directory|
-|\<any letter\> | search|
-
-### using with docker
-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
 # pull from dockerhub and run
 % 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. for instance [caddy](https://caddyserver.com/) handles this very well - have a look at this small [caddy config](https://github.com/pldubouilh/gossa/blob/master/support/Caddyfile) with authentication and option for HTTPS that works along with gossa.
+
+### shortcuts
+the default UI is fully usable by through keyboard/UI shortcuts - press `Ctrl/Cmd + h` to see them all.
+

src/gossa.go

@@ -22,8 +22,8 @@ var host = flag.String("h", "127.0.0.1", "host to listen to")
 var port = flag.String("p", "8001", "port to listen to")
 var extraPath = flag.String("prefix", "/", "url prefix at which gossa can be reached, e.g. /gossa/ (slashes of importance)")
 var symlinks = flag.Bool("symlinks", false, "follow symlinks \033[4mWARNING\033[0m: symlinks will by nature allow to escape the defined path (default: false)")
-var verb = flag.Bool("verb", true, "verbosity")
+var verb = flag.Bool("verb", false, "verbosity")
-var skipHidden = flag.Bool("k", true, "skip hidden files")
+var skipHidden = flag.Bool("k", true, "\nskip hidden files")
 var initPath = "."
 
 var fs http.Handler
@@ -162,11 +162,11 @@ func rpc(w http.ResponseWriter, r *http.Request) {
 }
 
 func checkPath(p string) string {
-	p = filepath.Join(initPath, strings.TrimPrefix(p, *extraPath))
+	joined := filepath.Join(initPath, strings.TrimPrefix(p, *extraPath))
-	fp, err := filepath.Abs(p)
+	fp, err := filepath.Abs(joined)
 	sl, _ := filepath.EvalSymlinks(fp)
 
-	if err != nil || !strings.HasPrefix(fp, initPath) || len(sl) > 0 && !*symlinks && !strings.HasPrefix(sl, initPath) {
+	if err != nil || !strings.HasPrefix(fp, initPath) || *skipHidden && strings.Contains(p, "/.") || !*symlinks && len(sl) > 0 && !strings.HasPrefix(sl, initPath) {
 		panic(errors.New("invalid path"))
 	}
 
@@ -174,23 +174,25 @@ func checkPath(p string) string {
 }
 
 func main() {
+	var err error
+	flag.Usage = func() {
+		fmt.Printf("\nusage: ./gossa ~/directory-to-share\n\n")
+		flag.PrintDefaults()
+	}
+
 	flag.Parse()
 	if len(flag.Args()) > 0 {
 		initPath = flag.Args()[0]
 	}
 
-	var err error
 	initPath, err = filepath.Abs(initPath)
 	check(err)
 
-	hostString := *host + ":" + *port
-	fmt.Println("Gossa startig on directory " + initPath)
-	fmt.Println("Listening on http://" + hostString + *extraPath)
-
 	http.HandleFunc(*extraPath+"rpc", rpc)
 	http.HandleFunc(*extraPath+"post", upload)
 	http.HandleFunc("/", doContent)
 	fs = http.StripPrefix(*extraPath, http.FileServer(http.Dir(initPath)))
-	err = http.ListenAndServe(hostString, nil)
+	fmt.Printf("Gossa startig on directory %s\nListening on http://%s:%s%s\n", initPath, *host, *port, *extraPath)
+	err = http.ListenAndServe(*host+":"+*port, nil)
 	check(err)
 }

src/gossa_test.go

@@ -55,39 +55,37 @@ func postJSON(t *testing.T, url string, what string) string {
 }
 
 func fetchAndTestDefault(t *testing.T, url string) string {
-	bodyStr := get(t, url)
+	body0 := get(t, url)
 
-	if !strings.Contains(bodyStr, `<title>/</title>`) {
+	if !strings.Contains(body0, `<title>/</title>`) {
 		t.Fatal("error title")
 	}
 
-	if !strings.Contains(bodyStr, `<h1>./</h1>`) {
+	if !strings.Contains(body0, `<h1 onclick="return titleClick(event)">./</h1>`) {
 		t.Fatal("error header")
 	}
 
-	if !strings.Contains(bodyStr, `href="hols">hols/</a>`) {
+	if !strings.Contains(body0, `href="hols">hols/</a>`) {
 		t.Fatal("error hols folder")
 	}
 
-	if !strings.Contains(bodyStr, `href="curimit@gmail.com%20%2840%25%29">curimit@gmail.com (40%)/</a>`) {
+	if !strings.Contains(body0, `href="curimit@gmail.com%20%2840%25%29">curimit@gmail.com (40%)/</a>`) {
 		t.Fatal("error curimit@gmail.com (40%) folder")
 	}
 
-	if !strings.Contains(bodyStr, `href="%E4%B8%AD%E6%96%87">中文/</a>`) {
+	if !strings.Contains(body0, `href="%E4%B8%AD%E6%96%87">中文/</a>`) {
 		t.Fatal("error 中文 folder")
 	}
 
-	if !strings.Contains(bodyStr, `href="custom_mime_type.types">custom_mime_type.types</a>`) {
+	if !strings.Contains(body0, `href="custom_mime_type.types">custom_mime_type.types</a>`) {
 		t.Fatal("error row custom_mime_type")
 	}
 
-	return bodyStr
+	return body0
 }
 
-func doTest(t *testing.T, url string, symlinkEnabled bool) {
+func doTest(t *testing.T, url string, testExtra bool) {
-	payload := ""
+	var payload, path, body0, body1, body2 string
-	path := ""
-	bodyStr := ""
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test fetching default path")
@@ -100,41 +98,42 @@ func doTest(t *testing.T, url string, symlinkEnabled bool) {
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test fetching regular files")
-	bodyStr = get(t, url+"subdir_with%20space/file_with%20space.html")
+	body0 = get(t, url+"subdir_with%20space/file_with%20space.html")
-	bodyStr2 := get(t, url+"fancy-path/a")
+	body1 = get(t, url+"fancy-path/a")
-	fmt.Println(bodyStr2)
+	if body0 != `<b>spacious!!</b> ` || body1 != `fancy! ` {
-	if !strings.Contains(bodyStr, `<b>spacious!!</b>`) || !strings.Contains(bodyStr2, `fancy!`) {
 		t.Fatal("fetching a regular file errored")
 	}
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test fetching a invalid file")
-	bodyStr = get(t, url+"../../../../../../../../../../etc/passwd")
+	path = "../../../../../../../../../../etc/passwd"
-	if !strings.Contains(bodyStr, `error`) {
+	if !testExtra && get(t, url+path) != `error` {
 		t.Fatal("fetching a invalid file didnt errored")
+	} else if testExtra {
+		fetchAndTestDefault(t, url+path) // extra path will just redirect to root dir
 	}
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test mkdir rpc")
-	bodyStr = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/AAA"]}`)
+	body0 = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/AAA"]}`)
-	if !strings.Contains(bodyStr, `ok`) {
+	if body0 != `ok` {
 		t.Fatal("mkdir rpc errored")
 	}
 
-	bodyStr = fetchAndTestDefault(t, url)
+	body0 = fetchAndTestDefault(t, url)
-	if !strings.Contains(bodyStr, `href="AAA">AAA/</a>`) {
+	if !strings.Contains(body0, `href="AAA">AAA/</a>`) {
 		t.Fatal("mkdir rpc folder not created")
 	}
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test invalid mkdir rpc")
-	bodyStr = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["../BBB"]}`)
+	body0 = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["../BBB"]}`)
-	if !strings.Contains(bodyStr, `error`) {
+	if body0 != `error` {
 		t.Fatal("invalid mkdir rpc didnt errored #0")
 	}
 
-	bodyStr = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/../BBB"]}`)
+	body0 = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/../BBB"]}`)
-	if !strings.Contains(bodyStr, `error`) {
+	if body0 != `error` {
 		t.Fatal("invalid mkdir rpc didnt errored #1")
 	}
 
@@ -142,94 +141,94 @@ func doTest(t *testing.T, url string, symlinkEnabled bool) {
 	fmt.Println("\r\n~~~~~~~~~~ test post file")
 	path = "%2F%E1%84%92%E1%85%A1%20%E1%84%92%E1%85%A1" // "하 하" encoded
 	payload = "123 하"
-	bodyStr = postDummyFile(t, url, path, payload)
+	body0 = postDummyFile(t, url, path, payload)
-	if !strings.Contains(bodyStr, `ok`) {
+	body1 = get(t, url+path)
+	body2 = fetchAndTestDefault(t, url)
+	if body0 != `ok` || body1 != payload || !strings.Contains(body2, `href="%E1%84%92%E1%85%A1%20%E1%84%92%E1%85%A1">하 하</a>`) {
 		t.Fatal("post file errored")
 	}
 
-	bodyStr = get(t, url+path)
-	if !strings.Contains(bodyStr, payload) {
-		t.Fatal("post file errored reaching new file")
-	}
-
-	bodyStr = fetchAndTestDefault(t, url)
-	if !strings.Contains(bodyStr, `href="%E1%84%92%E1%85%A1%20%E1%84%92%E1%85%A1">하 하</a>`) {
-		t.Fatal("post file errored checking new file row")
-	}
-
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test post file incorrect path")
-	bodyStr = postDummyFile(t, url, "%2E%2E"+path, payload)
+	body0 = postDummyFile(t, url, "%2E%2E"+path, payload)
-	if !strings.Contains(bodyStr, `err`) {
+	if !strings.Contains(body0, `err`) {
 		t.Fatal("post file incorrect path didnt errored")
 	}
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test mv rpc")
-	bodyStr = postJSON(t, url+"rpc", `{"call":"mv","args":["/AAA", "/hols/AAA"]}`)
+	body0 = postJSON(t, url+"rpc", `{"call":"mv","args":["/AAA", "/hols/AAA"]}`)
-	if !strings.Contains(bodyStr, `ok`) {
+	body1 = fetchAndTestDefault(t, url)
+	if body0 != `ok` || strings.Contains(body1, `href="AAA">AAA/</a></td> </tr>`) {
 		t.Fatal("mv rpc errored")
 	}
 
-	bodyStr = fetchAndTestDefault(t, url)
-	if strings.Contains(bodyStr, `href="AAA">AAA/</a></td> </tr>`) {
-		t.Fatal("mv rpc folder not moved")
-	}
-
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test upload in new folder")
-	payload = "abcdef1234"
+	payload = "test"
-	bodyStr = postDummyFile(t, url, "%2Fhols%2FAAA%2Fabcdef", payload)
+	body0 = postDummyFile(t, url, "%2Fhols%2FAAA%2Fabcdef", payload)
-	if strings.Contains(bodyStr, `err`) {
+	body1 = get(t, url+"hols/AAA/abcdef")
+	if body0 != `ok` || body1 != payload {
 		t.Fatal("upload in new folder errored")
 	}
 
-	bodyStr = get(t, url+"hols/AAA/abcdef")
-	if !strings.Contains(bodyStr, payload) {
-		t.Fatal("upload in new folder error reaching new file")
-	}
-
 	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test symlink, should succeed: ", symlinkEnabled)
+	fmt.Println("\r\n~~~~~~~~~~ test symlink, should succeed: ", testExtra)
-	bodyStr = get(t, url+"/docker/readme.md")
+	body0 = get(t, url+"/support/readme.md")
-	hasReadme := strings.Contains(bodyStr, `the master branch is automatically built and pushed`)
+	hasReadme := strings.Contains(body0, `the master branch is automatically built and pushed`)
-	if !symlinkEnabled && hasReadme {
+	if !testExtra && hasReadme {
 		t.Fatal("error symlink reached where illegal")
-	} else if symlinkEnabled && !hasReadme {
+	} else if testExtra && !hasReadme {
 		t.Fatal("error symlink unreachable")
 	}
 
-	if symlinkEnabled {
+	if testExtra {
-		fmt.Println("\r\n~~~~~~~~~~ test symlink mkdir")
+		fmt.Println("\r\n~~~~~~~~~~ test symlink mkdir & cleanup")
-		bodyStr = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/docker/testfolder"]}`)
+		body0 = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/support/testfolder"]}`)
-		if !strings.Contains(bodyStr, `ok`) {
+		if body0 != `ok` {
 			t.Fatal("error symlink mkdir")
 		}
+
+		body0 = postJSON(t, url+"rpc", `{"call":"rm","args":["/support/testfolder"]}`)
+		if body0 != `ok` {
+			t.Fatal("error symlink rm")
+		}
+	}
+
+	fmt.Println("\r\n~~~~~~~~~~ test hidden file, should succeed: ", testExtra)
+	body0 = get(t, url+"/.testhidden")
+	hasHidden := strings.Contains(body0, `test`)
+	if !testExtra && hasHidden {
+		t.Fatal("error hidden file reached where illegal")
+	} else if testExtra && !hasHidden {
+		t.Fatal("error hidden file unreachable")
+	}
+
+	//
+	fmt.Println("\r\n~~~~~~~~~~ test upload in new folder")
+	payload = "test"
+	body0 = postDummyFile(t, url, "%2Fhols%2FAAA%2Fabcdef", payload)
+	body1 = get(t, url+"hols/AAA/abcdef")
+	if body0 != `ok` || body1 != payload {
+		t.Fatal("upload in new folder errored")
 	}
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test rm rpc & cleanup")
-	bodyStr = postJSON(t, url+"rpc", `{"call":"rm","args":["/hols/AAA"]}`)
+	body0 = postJSON(t, url+"rpc", `{"call":"rm","args":["/hols/AAA"]}`)
-	if !strings.Contains(bodyStr, `ok`) {
+	if body0 != `ok` {
 		t.Fatal("cleanup errored #0")
 	}
 
-	bodyStr = get(t, url+"hols/AAA")
+	body0 = get(t, url+"hols/AAA")
-	if !strings.Contains(bodyStr, `error`) {
+	if !strings.Contains(body0, `error`) {
 		t.Fatal("cleanup errored #1")
 	}
 
-	bodyStr = postJSON(t, url+"rpc", `{"call":"rm","args":["/하 하"]}`)
+	body0 = postJSON(t, url+"rpc", `{"call":"rm","args":["/하 하"]}`)
-	if !strings.Contains(bodyStr, `ok`) {
+	if body0 != `ok` {
 		t.Fatal("cleanup errored #2")
 	}
-
-	if symlinkEnabled {
-		bodyStr = postJSON(t, url+"rpc", `{"call":"rm","args":["/docker/testfolder"]}`)
-		if !strings.Contains(bodyStr, `ok`) {
-			t.Fatal("error symlink rm")
-		}
-	}
 }
 
 func TestGetFolder(t *testing.T) {

support/Caddyfile

@@ -0,0 +1,8 @@
+# Caddy config
+# to enable https just set a valid domain (e.g. mydomain.com) instead of :8080 - how simple !
+# authentication has been setup with 2 users, alice and bob
+
+:8080
+basicauth / alice paul
+basicauth / bob dylan
+proxy / 127.0.0.1:8001

support/caddy.Dockerfile

@@ -0,0 +1,8 @@
+FROM pldubouilh/gossa
+
+RUN apk update && apk add curl ca-certificates caddy
+
+ENV UID="1000" GID="1000" HOST="127.0.0.1" PORT="8001" PREFIX="/" FOLLOW_SYMLINKS="false" SKIP_HIDDEN_FILES="true" DATADIR="/shared"
+EXPOSE 443
+RUN echo -e 'exec su-exec ${UID}:${GID} /gossa -h ${HOST} -p ${PORT} -k=${SKIP_HIDDEN_FILES} --symlinks=${FOLLOW_SYMLINKS} --prefix=${PREFIX} ${DATADIR} & \n caddy' > /start.sh
+ENTRYPOINT [ "sh", "/start.sh" ]

support/readme.md

@@ -8,22 +8,20 @@ the master branch is automatically built and pushed to [dockerhub](https://hub.d
 if you prefer building the image yourself :
 
 ```sh
-# build gossa within a build container, needs to be ran within the sources, ../ from here
+# build gossa within a build container, needs to be ran within the sources, ../ from here, and run
-% docker build -t gossa -f docker/build.Dockerfile .
+% docker build -t gossa -f support/build.Dockerfile .
-
-# and to run it simply
 % 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 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 🎉
+a fancy docker image using [Caddy](https://caddyserver.com/) is also provided. have a look at the simple config file `Caddyfile`, it shows how to use http basic authentication, and automatic TLS for hands-free https 🎉
 
 ```sh
-# run with caddy, checkout the config in the dockerfile
+# checkout the caddy config, build, and run docker image
-% docker build -t gossa -f caddy.Dockerfile .
+% vim caddy.Dockerfile
-
+% docker build -t gossa-caddy -f caddy.Dockerfile .
-# run with caddy
+% sudo docker run -v ~/LocalDirToShare:/shared -v `pwd`/Caddyfile:/Caddyfile --net=host gossa-caddy
-% 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.

test-fixture/.testhidden

@@ -0,0 +1 @@
+test