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
2024-05-13 15:37:58 +00:00

54 lines
2.2 KiB
Markdown

<!--
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
[![Integration level](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![Working status](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg)
[![Install h5ai with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=h5ai)
*[Read this README in other languages.](./ALL_README.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 is a modern file indexer for HTTP web servers with focus on your files. Directories are displayed in a appealing way and browsing them is enhanced by different views, a breadcrumb and a tree overview.
### Features
Some of the optional features are: file sorting, different view modes, localization, a breadcrumb, a tree view, custom headers and footers, file filter and search, folder sizes, auto refresh, packaged download, QR codes, thumbnails, file previews
**Shipped version:** 0.30.0~ynh11
**Demo:** <https://larsjung.de/h5ai/demo/>
## Screenshots
![Screenshot of h5ai](./doc/screenshots/screenshot.jpg)
## 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 Store: <https://apps.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](https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing).
To try the `testing` branch, please proceed like that:
```bash
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>