mirror of https://github.com/YunoHost-Apps/h5ai_ynh.git synced 2024-09-03 20:36:25 +02:00

h5ai package for YunoHost

Find a file

Tagada 5543e41f30 Apply suggestions from code review Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>		2022-08-20 22:53:10 +02:00
.github	Add templates	2021-05-12 09:27:55 +02:00
conf	Apply example_ynh	2022-03-31 17:39:38 +00:00
doc	Merge branch 'testing' into example_ynh	2022-04-01 13:58:54 +02:00
scripts	Apply suggestions from code review	2022-08-20 22:53:10 +02:00
.gitattributes	👾 Added .gitattributes & .gitignore files	2016-06-02 16:10:13 +02:00
.gitignore	👾 Added .gitattributes & .gitignore files	2016-06-02 16:10:13 +02:00
check_process	Reorder	2021-05-26 12:16:06 +02:00
config_panel.toml.example	Apply example_ynh	2022-03-31 17:39:38 +00:00
LICENSE	First Commit	2016-06-02 16:10:37 +02:00
manifest.json	Apply suggestions from code review	2022-08-20 22:53:10 +02:00
README.md	Auto-update README	2021-11-29 14:31:34 +00:00
README_fr.md	Auto-update README	2021-11-29 14:31:34 +00:00

README.md

h5ai for YunoHost

Lire ce readme en français.

This package allows you to install h5ai quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Modern HTTP web server index for NGINX

Shipped version: 0.30.0~ynh3

Screenshots

Disclaimers / important information

Configuration

After installing the application, you can add documents in /var/www/documents (or the corresponding path you choosed).
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 and resources

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

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug
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