1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ombi_ynh.git synced 2024-09-03 19:55:54 +02:00
ombi_ynh/README.md

51 lines
2 KiB
Markdown
Raw Normal View History

2023-10-04 13:40:24 +02:00
<!--
2024-03-29 07:15:38 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2023-10-04 13:40:24 +02:00
It shall NOT be edited by hand.
-->
2023-10-04 13:40:33 +02:00
# Ombi for YunoHost
2023-10-04 13:40:24 +02:00
2023-10-04 13:40:33 +02:00
[![Integration level](https://dash.yunohost.org/integration/ombi.svg)](https://dash.yunohost.org/appci/app/ombi) ![Working status](https://ci-apps.yunohost.org/ci/badges/ombi.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ombi.maintain.svg)
[![Install Ombi with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ombi)
2023-10-04 13:40:24 +02:00
2024-03-29 07:15:38 +01:00
*[Read this README is other languages.](./ALL_README.md)*
2023-10-04 13:40:24 +02:00
2024-03-29 07:15:38 +01:00
> *This package allows you to install Ombi 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.*
2023-10-04 13:40:24 +02:00
## Overview
2023-10-04 13:40:33 +02:00
Ombi is a self-hosted web application that automatically gives your shared Plex or Emby users the ability to request content by themselves! Ombi can be linked to multiple TV Show and Movie DVR tools to create a seamless end-to-end experience for your users.
2023-10-04 13:40:24 +02:00
2023-10-04 13:40:33 +02:00
**Shipped version:** 4.43.5~ynh1
2023-10-04 13:40:24 +02:00
2024-03-29 07:15:38 +01:00
**Demo:** <https://app.ombi.io/landingpage>
2023-10-04 13:40:24 +02:00
## Screenshots
2023-10-04 13:40:33 +02:00
![Screenshot of Ombi](./doc/screenshots/screenshot.png)
2023-10-04 13:40:24 +02:00
## Documentation and resources
2024-03-29 07:15:38 +01:00
- Official app website: <https://ombi.io/>
- Official admin documentation: <https://docs.ombi.app/guides/installation/>
- Upstream app code repository: <https://github.com/Ombi-app/Ombi>
- YunoHost Store: <https://apps.yunohost.org/app/ombi>
- Report a bug: <https://github.com/YunoHost-Apps/ombi_ynh/issues>
2023-10-04 13:40:24 +02:00
## Developer info
2024-03-29 07:15:38 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/ombi_ynh/tree/testing).
2023-10-04 13:40:24 +02:00
2024-03-29 07:15:38 +01:00
To try the `testing` branch, please proceed like that:
2023-10-04 13:40:24 +02:00
2024-03-29 07:15:38 +01:00
```bash
2023-10-04 13:40:33 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/ombi_ynh/tree/testing --debug
2023-10-04 13:40:24 +02:00
or
2023-10-04 13:40:33 +02:00
sudo yunohost app upgrade ombi -u https://github.com/YunoHost-Apps/ombi_ynh/tree/testing --debug
2023-10-04 13:40:24 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>