YunoHost-Apps/audiobookshelf_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/audiobookshelf_ynh.git synced 2024-09-03 18:06:19 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-04-16 07:08:45 +00:00
parent 985f151c97
commit 0c56aa911b
2 changed files with 64 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
README.md
View file

@ -1,45 +1,38 @@
# Packaging your an app, starting from this example
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
- Edit the `manifest.json` with app specific info.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
- Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
- Add a `LICENSE` file for the package.
- Edit `doc/DISCLAIMER*.md`
- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # Audiobookshelf for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/audiobookshelf.svg)](https://dash.yunohost.org/appci/app/audiobookshelf) ![](https://ci-apps.yunohost.org/ci/badges/audiobookshelf.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/audiobookshelf.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Audiobookshelf with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=audiobookshelf)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Example app quickly and simply on a YunoHost server. > *This package allows you to install Audiobookshelf 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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Audiobookshelf is a self-hosted audiobook server for managing and playing your audiobooks.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; * Fully **open-source**, including the [android & iOS app](https://github.com/advplyr/audiobookshelf-app) *(in beta)*
- Laboris nisi ut aliquip ex ea commodo consequat ; * Stream all audiobook formats on the fly
- Duis aute irure dolor in reprehenderit in voluptate ; * Multi-user support w/ custom permissions
- Velit esse cillum dolore eu fugiat nulla pariatur ; * Keeps progress per user and syncs across devices
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." * Auto-detects library updates, no need to re-scan
* Upload audiobooks w/ bulk upload drag and drop folders
* Backup your metadata + automated daily backups
* Progressive Web App (PWA)
* Chromecast support on the web app
* Fetch metadata and cover art from several sources
**Shipped version:** 1.7.2~ynh1
**Shipped version:** 1.0~ynh1 **Demo:** https://audiobookshelf.org/
**Demo:** https://demo.example.com
## Screenshots ## Screenshots
@ -47,37 +40,33 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Disclaimers / important information ## Disclaimers / important information
* Any known limitations, constrains or stuff not working, such as (but not limited to): ## Limitations
* 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: * Audiobookshelf can only be installed on a dedicated domain
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) * No LDAP support
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ? ## Administration
* security considerations ?
* Default user is "root" with no password
## Documentation and resources ## Documentation and resources
* Official app website: https://example.com * Official app website: https://audiobookshelf.org/
* Official user documentation: https://yunohost.org/apps * Official user documentation: https://www.audiobookshelf.org/docs
* Official admin documentation: https://yunohost.org/packaging_apps * Official admin documentation: https://yunohost.org/packaging_apps
* Upstream app code repository: https://some.forge.com/example/example * Upstream app code repository: https://github.com/advplyr/audiobookshelf
* YunoHost documentation for this app: https://yunohost.org/app_example * YunoHost documentation for this app: https://yunohost.org/app_audiobookshelf
* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/audiobookshelf_ynh/issues
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/audiobookshelf_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/audiobookshelf_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade audiobookshelf -u https://github.com/YunoHost-Apps/audiobookshelf_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** https://yunohost.org/packaging_apps

64
README_fr.md
View file

@ -1,30 +1,34 @@
# Example app pour YunoHost # Audiobookshelf pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/audiobookshelf.svg)](https://dash.yunohost.org/appci/app/audiobookshelf) ![](https://ci-apps.yunohost.org/ci/badges/audiobookshelf.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/audiobookshelf.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Audiobookshelf avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=audiobookshelf)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Audiobookshelf 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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Audiobookshelf is a self-hosted audiobook server for managing and playing your audiobooks.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; * Fully **open-source**, including the [android & iOS app](https://github.com/advplyr/audiobookshelf-app) *(in beta)*
- Laboris nisi ut aliquip ex ea commodo consequat ; * Stream all audiobook formats on the fly
- Duis aute irure dolor in reprehenderit in voluptate ; * Multi-user support w/ custom permissions
- Velit esse cillum dolore eu fugiat nulla pariatur ; * Keeps progress per user and syncs across devices
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." * Auto-detects library updates, no need to re-scan
* Upload audiobooks w/ bulk upload drag and drop folders
* Backup your metadata + automated daily backups
* Progressive Web App (PWA)
* Chromecast support on the web app
* Fetch metadata and cover art from several sources
**Version incluse :** 1.7.2~ynh1
**Version incluse :** 1.0~ynh1 **Démo :** https://audiobookshelf.org/
**Démo :** https://demo.example.com
## Captures d'écran ## Captures d'écran
@ -32,37 +36,33 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Avertissements / informations importantes ## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to): ## Limitations
* 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: * Audiobookshelf can only be installed on a dedicated domain
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) * No LDAP support
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ? ## Administration
* security considerations ?
* Default user is "root" with no password
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://example.com * Site officiel de l'app : https://audiobookshelf.org/
* Documentation officielle utilisateur : https://yunohost.org/apps * Documentation officielle utilisateur : https://www.audiobookshelf.org/docs
* Documentation officielle de l'admin : https://yunohost.org/packaging_apps * Documentation officielle de l'admin : https://yunohost.org/packaging_apps
* Dépôt de code officiel de l'app : https://some.forge.com/example/example * Dépôt de code officiel de l'app : https://github.com/advplyr/audiobookshelf
* Documentation YunoHost pour cette app : https://yunohost.org/app_example * Documentation YunoHost pour cette app : https://yunohost.org/app_audiobookshelf
* Signaler un bug : https://github.com/YunoHost-Apps/example_ynh/issues * Signaler un bug : https://github.com/YunoHost-Apps/audiobookshelf_ynh/issues
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/audiobookshelf_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/audiobookshelf_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade audiobookshelf -u https://github.com/YunoHost-Apps/audiobookshelf_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps