2021-05-21 14:24:10 +02:00
|
|
|
<!--
|
|
|
|
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.
|
|
|
|
-->
|
|
|
|
|
2021-05-21 18:34:01 +02:00
|
|
|
# Jackett for YunoHost
|
2021-05-21 14:24:10 +02:00
|
|
|
|
2021-11-22 09:30:26 +01:00
|
|
|
[![Integration level](https://dash.yunohost.org/integration/jackett.svg)](https://dash.yunohost.org/appci/app/jackett) ![](https://ci-apps.yunohost.org/ci/badges/jackett.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jackett.maintain.svg)
|
|
|
|
[![Install Jackett with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jackett)
|
2021-05-21 14:24:10 +02:00
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
2021-11-22 09:30:26 +01:00
|
|
|
> *This package allows you to install Jackett quickly and simply on a YunoHost server.
|
2021-05-21 14:24:10 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2021-05-22 20:59:39 +02:00
|
|
|
It provides API support for your favorite torrent trackers.
|
2021-05-21 14:24:10 +02:00
|
|
|
|
2021-05-21 18:34:01 +02:00
|
|
|
**Shipped version:** 0.18.98~ynh1
|
2021-05-21 14:24:10 +02:00
|
|
|
|
2021-05-21 18:34:01 +02:00
|
|
|
**Demo:** https://github.com/Jackett/Jackett
|
2021-05-21 14:24:10 +02:00
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
2021-11-22 09:30:26 +01:00
|
|
|
![](./doc/screenshots/demo.png)
|
2021-05-21 14:24:10 +02:00
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
|
|
|
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
2021-05-21 18:34:01 +02:00
|
|
|
* No LDAP Support
|
2021-05-21 14:24:10 +02:00
|
|
|
## Documentation and resources
|
|
|
|
|
2021-05-21 18:34:01 +02:00
|
|
|
* Official app website: https://github.com/Jackett/Jackett
|
2021-05-21 14:24:10 +02:00
|
|
|
* Official user documentation: https://yunohost.org/apps
|
|
|
|
* Official admin documentation: https://yunohost.org/packaging_apps
|
2021-11-22 09:30:26 +01:00
|
|
|
* Upstream app code repository: https://github.com/Jackett/Jackett
|
2021-05-21 18:34:01 +02:00
|
|
|
* YunoHost documentation for this app: https://yunohost.org/app_jackett
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/jackett_ynh/issues
|
2021-05-21 14:24:10 +02:00
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
2021-05-21 18:34:01 +02:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/jackett_ynh/tree/testing).
|
2021-05-21 14:24:10 +02:00
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
```
|
2021-05-21 18:08:30 +02:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug
|
2021-05-21 14:24:10 +02:00
|
|
|
or
|
2021-05-21 18:08:30 +02:00
|
|
|
sudo yunohost app upgrade jackett -u https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug
|
2021-05-21 14:24:10 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|