Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pldubouilh committed Jul 8, 2023
1 parent 17e18ca commit 58b6840
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,24 @@ a simple UI comes as default, featuring :

* πŸ” files/directories browser & handler
* πŸ“© drag-and-drop uploader
* πŸ₯‚ fast golang static server
* πŸ’Ύ 90s web UI that prints in milliseconds
* πŸ“Έ video streaming & picture browser
* πŸ“Έ video streaming, picture browser, pdf viewer
* ✍️ simple note editor
* ⌨️ keyboard navigation
* πŸš€ lightweight and dependency free codebase
* πŸ”’ >95% test coverage and reproducible builds
* πŸ₯‚ fast golang static server
* πŸ’‘ easy multi account setup, read-only mode
* ✨ PWA enabled
* ✨ PWA-able

### 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.
### install / build
[arch linux (AUR)](https://aur.archlinux.org/packages/gossa/) - e.g. `yay -S gossa`

arch linux users can also install through the [user repos](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`

automatic boot-time startup can be handled with a user systemd service - see [support](https://github.com/pldubouilh/gossa/tree/master/support)
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.

### usage
```sh
Expand All @@ -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.

automatic boot-time startup can be handled with a user systemd service - see [support](https://github.com/pldubouilh/gossa/tree/master/support)

0 comments on commit 58b6840

Please sign in to comment.