mirror of
https://github.com/pldubouilh/gossa
synced 2025-12-06 08:22:32 +01:00
56 lines
2.4 KiB
Markdown
56 lines
2.4 KiB
Markdown
gossa
|
|
=============
|
|
|
|
|
|
|
|
[](https://github.com/pldubouilh/gossa/actions)
|
|
[](https://hub.docker.com/r/pldubouilh/gossa)
|
|
[](https://hub.docker.com/r/pldubouilh/gossa)
|
|
[](https://github.com/pldubouilh/gossa/releases)
|
|
|
|
a fast and simple webserver for your files, that's dependency-free and with under 250 lines of code, easy to review.
|
|
|
|
a [simple UI](https://github.com/pldubouilh/gossa-ui) comes as default, featuring :
|
|
|
|
* 🔍 files/directories browser & handler
|
|
* 📩 drag-and-drop uploader
|
|
* 🥂 fast golang static server
|
|
* 💾 90s web UI that prints in ms
|
|
* 📸 picture browser
|
|
* 📽️ video streaming
|
|
* ✍️ simple text/note editor
|
|
* ⌨️ keyboard navigation
|
|
* 🚀 lightweight codebase and dependency free
|
|
* 🔒 >95% test coverage and reproducible builds
|
|
* 💑 easy/secure multi account setup, read-only mode
|
|
* ✨ PWA enabled
|
|
|
|
### build
|
|
built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases) - or simply `make build` this repo.
|
|
all builds are reproducible, checkout the hashes on the release page.
|
|
|
|
arch linux users can also install through the [user repos](https://aur.archlinux.org/packages/gossa/) - e.g. `yay -S gossa`
|
|
|
|
automatic boot-time startup can be handled with a user systemd service - see [support](https://github.com/pldubouilh/gossa/tree/master/support)
|
|
|
|
### usage
|
|
```sh
|
|
% ./gossa --help
|
|
|
|
% ./gossa -h 192.168.100.33 ~/storage
|
|
```
|
|
|
|
### shortcuts
|
|
press `Ctrl/Cmd + h` to see all the UI/keyboard shortcuts.
|
|
|
|
### fancier setups
|
|
release images are 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. [sample caddy configs](https://github.com/pldubouilh/gossa/blob/master/support/) are available to quickly setup multi users setups along with https.
|
|
|
|
|