[](https://install-app.yunohost.org/?app=h5ai)
*[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.*
## 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.
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.
