gossa/readme.md
Pierre Dubouilh 56f418bbff
reword readme
2020-06-28 13:10:44 +02:00

2.1 KiB

gossa

e

build status docker build status docker pulls github downloads

a fast and simple webserver for your files, that's dependency-free and with under 200 lines of code, easy to review.

a simple UI comes as default, featuring :

  • 🔍 files/directories browser
  • 📩 drag-and-drop file/directory uploader
  • 🚀 lightweight, default ui weights 110kB and prints in ms
  • 🗺️ files handling - move/rename/delete
  • 📸 picture browser
  • 📽️ video streaming
  • ✍️ simple text editor
  • ⌨️ keyboard shortcuts
  • 🥂 fast golang static server, easily fills available bandwidth
  • 🔒 easy/secure multi account setup

build

built blobs are available on the release page - or simply make build this repo.

usage

% ./gossa --help

% ./gossa -h 192.168.100.33 ~/storage

fancier setups

release images are pushed to dockerhub, e.g. :

# 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. sample caddy configs 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.