mirror of
https://github.com/YunoHost-Apps/gossa_ynh.git
synced 2024-09-03 18:36:29 +02:00
Auto-update README
This commit is contained in:
yunohost-bot
parent
3ab8dba592
commit
0fe93d2c29
2 changed files with 104 additions and 96 deletions
96
README.md
96
README.md
|
|
@ -1,71 +1,75 @@
|
|||
<!--
|
||||
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://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.
|
||||
> *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
|
||||
Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your music collection from any browser or mobile device.
|
||||
|
||||
**Shipped version:** 0.1.7.1
|
||||
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
|
||||
|
||||
|
||||
|
||||
|
||||
## Demo
|
||||
## Disclaimers / important information
|
||||
|
||||
* [Official demo](https://demo.navidrome.org/app/#/login)
|
||||
* 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...
|
||||
|
||||
## Configuration
|
||||
* 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 ?
|
||||
|
||||
#### Where are stored your music files
|
||||
## Documentation and resources
|
||||
|
||||
Your music files are stored by default in your shared [multimedia folder](https://github.com/YunoHost-Apps/yunohost.multimedia) `/home/yunohost.multimedia/share/Music`. This folder is accessible from Nextcloud with *External Storages* enabled. This will allow you to easily upload your music files to the server.
|
||||
|
||||
You can configure an alternative path to you music files by editing the path `MusicFolder = "/home/yunohost.multimedia/share/Music"` in this file `/var/lib/navidrome/navidrome.toml` using the [documentation](https://www.navidrome.org/docs/usage/configuration-options/).
|
||||
|
||||
#### Client player
|
||||
|
||||
You must activate *public site* if you want to connect a client player to Navidrome.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://www.navidrome.org/docs/
|
||||
* YunoHost documentation: https://yunohost.org/#/app_navidrome
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
* Is LDAP supported? **No**
|
||||
* Can the app be used by multiple users? **Yes**
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/navidrome/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/navidrome/)
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/navidrome_ynh/issues
|
||||
* App website: https://github.com/pldubouilh/gossa
|
||||
* Upstream app repository: https://github.com/deluan/navidrome/
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
* 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/navidrome_ynh/tree/testing).
|
||||
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.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/gossa_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade navidrome -u https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
|
||||
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>
|
||||
|
|
|
|||
104
README_fr.md
104
README_fr.md
|
|
@ -1,71 +1,75 @@
|
|||
# Navidrome pour YunoHost
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/navidrome)  
|
||||
[](https://install-app.yunohost.org/?app=navidrome)
|
||||
# Gossa pour YunoHost
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
[](https://dash.yunohost.org/appci/app/gossa)  
|
||||
[](https://install-app.yunohost.org/?app=gossa)
|
||||
|
||||
> *Ce package vous permet d'installer Navidrome rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Gossa rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
Navidrome est un serveur et un streamer de collection de musique en ligne open source. Il vous donne la liberté d'écouter votre playlist à partir de n'importe quel navigateur ou appareil mobile.
|
||||
|
||||
**Version incluse :** 0.39.0
|
||||
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
|
||||
|
||||
|
||||
**Version incluse :** 0.2.1~ynh1
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
## Démo
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* [Démo officielle](https://demo.navidrome.org/app/#/login)
|
||||
* 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...
|
||||
|
||||
## Configuration
|
||||
* 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 ?
|
||||
|
||||
#### Où stocker votre musique
|
||||
## Documentations et ressources
|
||||
|
||||
Votre musique est a stockée par default dans le [dossier multimédia](https://github.com/YunoHost-Apps/yunohost.multimedia) partagé `/home/yunohost.multimedia/share/Music`. Ce dossier, facilement accessible depuis Nextcloud avec *Stockages externes* activée, vous permettra d'*uploader* facilement vos fichiers de musique sur votre server.
|
||||
|
||||
Vous pouvez personnaliser le dossier de stockage de vos fichiers de musique en éditant le fichier de configuration `/var/lib/navidrome/navidrome.toml` et rediriger la variable `MusicFolder = "/home/yunohost.multimedia/share/Music"`. Vous pouvez également changer d'autre réglage en vous aidant de la [documentation](https://www.navidrome.org/docs/usage/configuration-options/).
|
||||
|
||||
#### Utilisation d'un client
|
||||
|
||||
Vous devez activer *site public* si vous souhaitez connecter un lecteur client à Navidrome.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle : https://www.navidrome.org/docs/
|
||||
* Documentation YunoHost : https://yunohost.org/#/app_navidrome_fr
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateur
|
||||
|
||||
* L'authentification LDAP est-elle prise en charge ? **Non**
|
||||
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
|
||||
|
||||
#### Architectures supportées
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/navidrome/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/navidrome/)
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/navidrome_ynh/issues
|
||||
* Site de l'application : https://www.navidrome.org/
|
||||
* Dépôt de l'application principale : https://github.com/deluan/navidrome/
|
||||
* Site web YunoHost : https://yunohost.org/
|
||||
|
||||
---
|
||||
* Site officiel de l'app : <https://github.com/pldubouilh/gossa>
|
||||
* Dépôt de code officiel de l'app : <https://github.com/pldubouilh/gossa>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_gossa>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/gossa_ynh/issues>
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing).
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gossa_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/gossa_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade navidrome -u https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade gossa -u https://github.com/YunoHost-Apps/gossa_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
||||
|
|
|
|||
Loading…
Reference in a new issue