mirror of
https://github.com/YunoHost-Apps/gossa_ynh.git
synced 2024-09-03 18:36:29 +02:00
75 lines
3 KiB
Markdown
75 lines
3 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Gossa for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/gossa)  
|
|
[](https://install-app.yunohost.org/?app=gossa)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Gossa quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
A fast and simple webserver for your files, that's dependency-free and with under 250 lines of code, easy to review.
|
|
|
|
### Features
|
|
|
|
🔍 files/directories browser & handler
|
|
📩 drag-and-drop uploader
|
|
🥂 fast golang static server
|
|
💾 90s web UI that prints in milliseconds
|
|
📸 video streaming & picture browser
|
|
✍️ simple note editor
|
|
⌨️ keyboard navigation
|
|
🚀 lightweight and dependency free codebase
|
|
🔒 >95% test coverage and reproducible builds
|
|
💑 easy multi account setup, read-only mode
|
|
✨ PWA enabled
|
|
|
|
|
|
**Shipped version:** 0.2.1~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
|
* requiring a full dedicated domain ?
|
|
* architectures not supported ?
|
|
* not-working single-sign on or LDAP integration ?
|
|
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
|
* etc...
|
|
|
|
* Other infos that people should be aware of, such as:
|
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
|
* how to configure / administrate the application if it ain't obvious
|
|
* upgrade process / specificities / things to be aware of ?
|
|
* security considerations ?
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://github.com/pldubouilh/gossa>
|
|
* Upstream app code repository: <https://github.com/pldubouilh/gossa>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_gossa>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/gossa_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gossa_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/gossa_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade gossa -u https://github.com/YunoHost-Apps/gossa_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|