1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gossa_ynh.git synced 2024-09-03 18:36:29 +02:00
gossa_ynh/README.md

61 lines
2.2 KiB
Markdown
Raw Normal View History

2022-05-26 20:24:13 +02:00
<!--
2024-03-29 07:05:24 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2022-05-26 20:24:13 +02:00
It shall NOT be edited by hand.
-->
2022-05-26 20:24:05 +02:00
# Gossa for YunoHost
2023-07-08 17:28:49 +02:00
[![Integration level](https://dash.yunohost.org/integration/gossa.svg)](https://dash.yunohost.org/appci/app/gossa) ![Working status](https://ci-apps.yunohost.org/ci/badges/gossa.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gossa.maintain.svg)
2022-05-26 20:24:05 +02:00
[![Install Gossa with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gossa)
2024-03-29 07:05:24 +01:00
*[Read this README is other languages.](./ALL_README.md)*
2022-05-26 20:24:05 +02:00
2024-03-29 07:05:24 +01:00
> *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.*
2022-05-26 20:24:05 +02:00
## Overview
2022-05-26 20:24:13 +02:00
A fast and simple webserver for your files, that's dependency-free and with under 250 lines of code, easy to review.
2022-05-26 20:24:05 +02:00
2022-05-26 20:24:13 +02:00
### Features
2022-05-26 20:24:05 +02:00
2022-05-26 20:24:13 +02:00
🔍 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
2022-05-26 20:24:05 +02:00
2023-07-08 17:38:18 +02:00
**Shipped version:** 1.0.0~ynh1
2022-05-26 20:24:05 +02:00
2022-05-26 20:24:13 +02:00
## Screenshots
2022-05-26 20:24:05 +02:00
2023-01-11 18:04:09 +01:00
![Screenshot of Gossa](./doc/screenshots/screenshot.png)
2022-05-26 20:24:05 +02:00
2022-05-26 20:24:13 +02:00
## Documentation and resources
2022-05-26 20:24:05 +02:00
2024-03-29 07:05:24 +01:00
- Upstream app code repository: <https://github.com/pldubouilh/gossa>
- YunoHost Store: <https://apps.yunohost.org/app/gossa>
- Report a bug: <https://github.com/YunoHost-Apps/gossa_ynh/issues>
2022-05-26 20:24:05 +02:00
## Developer info
2024-03-29 07:05:24 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/gossa_ynh/tree/testing).
2022-05-26 20:24:05 +02:00
2024-03-29 07:05:24 +01:00
To try the `testing` branch, please proceed like that:
2022-05-26 20:24:13 +02:00
2024-03-29 07:05:24 +01:00
```bash
2022-05-26 20:24:13 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/gossa_ynh/tree/testing --debug
2022-05-26 20:24:05 +02:00
or
2022-05-26 20:24:13 +02:00
sudo yunohost app upgrade gossa -u https://github.com/YunoHost-Apps/gossa_ynh/tree/testing --debug
2022-05-26 20:24:05 +02:00
```
2022-05-26 20:24:13 +02:00
2024-03-29 07:05:24 +01:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>