1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/h5ai_ynh.git synced 2024-09-03 20:36:25 +02:00
h5ai_ynh/README.md
2021-02-02 10:55:41 +01:00

2.7 KiB

h5ai for YunoHost

Integration level
Install h5ai with 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

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

Screenshot :

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

  • Official documentation: https://larsjung.de/h5ai/
  • YunoHost documentation: If specific documentation is needed, feel free to contribute.

YunoHost specific features

Supported architectures

  • x86-64 - Build Status
  • ARMv8-A - Build Status

Limitations

  • Any known limitations.

Additional information

  • Other info you would like to add about this app.

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