1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/libremdb_ynh.git synced 2024-09-03 19:36:22 +02:00
libremdb_ynh/README.md
2022-12-29 11:42:00 +00:00

73 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!--
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.
-->
# Libremdb for YunoHost
[![Integration level](https://dash.yunohost.org/integration/libremdb.svg)](https://dash.yunohost.org/appci/app/libremdb) ![Working status](https://ci-apps.yunohost.org/ci/badges/libremdb.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/libremdb.maintain.svg)
[![Install Libremdb with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libremdb)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Libremdb 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
A free & open source IMDb front-end.
### Features
- Browse any movie info without being tracked or bombarded by annoying ads.
- Modern interface with curated colors supporting both dark and light themes.
- Be it your small mobile or big computer screen, its fully responsive.
- Lightweight
**Shipped version:** 2.2.2~ynh1
**Demo:** https://demo.example.com
## Screenshots
![Screenshot of Libremdb](./doc/screenshots/screenshot.png)
## Disclaimers / important information
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ?
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
## Documentation and resources
* Official app website: <https://libremdb.iket.me/>
* Official user documentation: <https://yunohost.org/apps>
* Official admin documentation: <https://yunohost.org/packaging_apps>
* Upstream app code repository: <https://github.com/zyachel/libremdb>
* YunoHost documentation for this app: <https://yunohost.org/app_libremdb>
* Report a bug: <https://github.com/YunoHost-Apps/libremdb_ynh/issues>
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/libremdb_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/libremdb_ynh/tree/testing --debug
or
sudo yunohost app upgrade libremdb -u https://github.com/YunoHost-Apps/libremdb_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>