mirror of
https://github.com/YunoHost-Apps/h5ai_ynh.git
synced 2024-09-03 20:36:25 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
c77b4833ee
commit
27c6fe314b
2 changed files with 45 additions and 67 deletions
57
README.md
57
README.md
|
|
@ -1,3 +1,8 @@
|
|||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# h5ai for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/h5ai)  
|
||||
|
|
@ -5,17 +10,22 @@
|
|||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install h5ai 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.*
|
||||
> *This package allows you to install h5ai 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
|
||||
[h5ai](https://larsjung.de/h5ai/) is a modern file indexer for HTTP web servers. It allows to display and browse directories containing various documents with a clean and light interface.
|
||||
|
||||
**Shipped version:** 0.30.0
|
||||
Modern HTTP web server index for NGINX.
|
||||
|
||||
Screenshot :
|
||||
**Shipped version:** 0.30.0~ynh2
|
||||
|
||||
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
@ -23,34 +33,13 @@ After installing the application, you can add documents in `/var/www/documents`
|
|||
h5ai doesn't allow to edit or upload new documents directly from the web browser. But you can imagine coupling the folder `/var/www/documents` to Nextcloud or some sort of FTP to allow some users to upload content, and use h5ai as a public read-only interface.
|
||||
The main configuration file is `_h5ai/private/conf/options.json`. You might want to change some of the documented settings. But there are some more files in `_h5ai/private/conf` you might have a look at.
|
||||
|
||||
## Documentation
|
||||
## Documentation and resources
|
||||
|
||||
* Official documentation: https://larsjung.de/h5ai/
|
||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/h5ai/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/h5ai/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* Any known limitations.
|
||||
|
||||
## Additional information
|
||||
|
||||
* Other info you would like to add about this app.
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/h5ai_ynh/issues
|
||||
* App website: https://larsjung.de/h5ai/
|
||||
* Upstream app repository: https://github.com/lrsjng/h5ai
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
* Official app website: https://larsjung.de/h5ai/
|
||||
* Official admin documentation: https://larsjung.de/h5ai/
|
||||
* Upstream app code repository: https://github.com/lrsjng/h5ai
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_h5ai
|
||||
* Report a bug: https://github.com/YunoHost-Apps/h5ai_ynh/issues
|
||||
|
||||
## Developer info
|
||||
|
||||
|
|
@ -62,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing
|
|||
or
|
||||
sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
55
README_fr.md
55
README_fr.md
|
|
@ -1,21 +1,27 @@
|
|||
# h5ai pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/h5ai)  
|
||||
[](https://dash.yunohost.org/appci/app/h5ai)  
|
||||
[](https://install-app.yunohost.org/?app=h5ai)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer h5ai 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.*
|
||||
> *Ce package vous permet d'installer h5ai 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
|
||||
[h5ai](https://larsjung.de/h5ai/) est un indexeur de fichiers moderne pour les serveurs Web HTTP. Il permet d'afficher et de parcourir des répertoires contenant divers documents avec une interface légère et claire.
|
||||
|
||||
**Version incluse :** 0.30.0
|
||||
Serveur moderne d'index pour NGINX.
|
||||
|
||||
**Version incluse :** 0.30.0~ynh2
|
||||
|
||||
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
@ -23,34 +29,13 @@ Après avoir installé l'application, vous pouvez ajouter des documents dans `/v
|
|||
h5ai ne permet pas de modifier ou de télécharger de nouveaux documents directement à partir du navigateur Web. Vous pouvez imaginer coupler le dossier `/var/www/documents` à Nextcloud ou un FTP pour permettre à certains utilisateurs de télécharger du contenu et d'utiliser h5ai comme interface publique en lecture seule.
|
||||
Le fichier de configuration principal est `_h5ai / private / conf / options.json`. Vous souhaiterez peut-être modifier certains des paramètres documentés. Mais il y a d'autres fichiers dans `_h5ai / private / conf` que vous pourriez consulter.
|
||||
|
||||
## Documentation
|
||||
## Documentations et ressources
|
||||
|
||||
* Documentation officielle : https://larsjung.de/h5ai/
|
||||
* Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Architectures supportées
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/h5ai/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/h5ai/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* Limitations connues.
|
||||
|
||||
## Informations additionnelles
|
||||
|
||||
* Autres informations que vous souhaitez ajouter sur cette application.
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/h5ai_ynh/issues
|
||||
* Site de l'application : https://larsjung.de/h5ai/
|
||||
* Dépôt de l'application principale : https://github.com/lrsjng/h5ai
|
||||
* Site web YunoHost : https://yunohost.org/
|
||||
|
||||
---
|
||||
* Site officiel de l'app : https://larsjung.de/h5ai/
|
||||
* Documentation officielle de l'admin : https://larsjung.de/h5ai/
|
||||
* Dépôt de code officiel de l'app : https://github.com/lrsjng/h5ai
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_h5ai
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/h5ai_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
|
|
@ -62,3 +47,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing
|
|||
ou
|
||||
sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Reference in a new issue