Backup_Repos/gossa
1
0
Fork 0
mirror of https://github.com/pldubouilh/gossa synced 2025-12-06 08:22:32 +01:00
Code Issues Projects Releases Wiki Activity

readme

Browse source
This commit is contained in:
Pierre Dubouilh 2023-07-08 15:22:19 +02:00 committed by Pierre Dubouilh
parent 17e18cabab
commit 58b6840c38
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
readme.md
View file

@ -13,24 +13,25 @@ a simple UI comes as default, featuring :
* 🔍 files/directories browser & handler * 🔍 files/directories browser & handler
* 📩 drag-and-drop uploader * 📩 drag-and-drop uploader
* 🥂 fast golang static server
* 💾 90s web UI that prints in milliseconds * 💾 90s web UI that prints in milliseconds
* 📸 video streaming & picture browser * 📸 video streaming, picture browser, pdf viewer
* ✍️ simple note editor * ✍️ simple note editor
* ⌨️ keyboard navigation * ⌨️ keyboard navigation
* 🚀 lightweight and dependency free codebase * 🚀 lightweight and dependency free codebase
* 🔒 >95% test coverage and reproducible builds * 🔒 >95% test coverage and reproducible builds
* 🥂 fast golang static server
* 💑 easy multi account setup, read-only mode * 💑 easy multi account setup, read-only mode
* ✨ PWA enabled * ✨ PWA-able
### install / build
[arch linux (AUR)](https://aur.archlinux.org/packages/gossa/) - e.g. `yay -S gossa`
[nix](https://search.nixos.org/packages?channel=unstable&show=gossa&from=0&size=50&sort=relevance&type=packages&query=gossa) - e.g. `nix-shell -p gossa`
### 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.
all builds are reproducible, checkout the hashes on the release page. 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 ### usage
```sh ```sh
% ./gossa --help % ./gossa --help
@ -52,4 +53,5 @@ release images are pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gos
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. 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.
automatic boot-time startup can be handled with a user systemd service - see [support](https://github.com/pldubouilh/gossa/tree/master/support)