jackett_ynh/README.md

<!--
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.
-->

# Jackett for YunoHost

[![Integration level](https://dash.yunohost.org/integration/jackett.svg)](https://dash.yunohost.org/appci/app/jackett) ![Working status](https://ci-apps.yunohost.org/ci/badges/jackett.status.svg) ![Maintenance status](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)

*[Read this README in other languages.](./ALL_README.md)*

> *This package allows you to install Jackett 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

Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.


**Shipped version:** 0.21.2371~ynh1

## Screenshots

![Screenshot of Jackett](./doc/screenshots/demo.png)

## Documentation and resources

- Upstream app code repository: <https://github.com/Jackett/Jackett>
- YunoHost Store: <https://apps.yunohost.org/app/jackett>
- Report a bug: <https://github.com/YunoHost-Apps/jackett_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/jackett_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug
or
sudo yunohost app upgrade jackett -u https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Initial commit 2021-05-21 14:24:10 +02:00			`<!--`
Auto-update READMEs 2024-04-15 03:36:45 +02:00			`N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>`
Initial commit 2021-05-21 14:24:10 +02:00			`It shall NOT be edited by hand.`
			`-->`

generated README 2021-05-21 18:34:01 +02:00			`# Jackett for YunoHost`
Initial commit 2021-05-21 14:24:10 +02:00
Auto-update README 2023-03-24 18:07:30 +01:00			`[![Integration level](https://dash.yunohost.org/integration/jackett.svg)](https://dash.yunohost.org/appci/app/jackett) ![Working status](https://ci-apps.yunohost.org/ci/badges/jackett.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jackett.maintain.svg)`

Auto-update README 2021-11-22 09:40:29 +01:00			`[![Install Jackett with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jackett)`
Initial commit 2021-05-21 14:24:10 +02:00
Auto-update READMEs 2024-04-15 03:36:45 +02:00			`[Read this README in other languages.](./ALL_README.md)`
Initial commit 2021-05-21 14:24:10 +02:00
Auto-update READMEs 2024-04-15 03:36:45 +02:00			`> This package allows you to install Jackett 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.`
Initial commit 2021-05-21 14:24:10 +02:00
			`## Overview`

Auto-update README 2024-02-25 22:20:56 +01:00			`Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.`

Initial commit 2021-05-21 14:24:10 +02:00
Auto-update READMEs 2024-04-15 03:36:45 +02:00			`Shipped version: 0.21.2371~ynh1`
Initial commit 2021-05-21 14:24:10 +02:00
			`## Screenshots`

Auto-update README 2022-05-27 14:36:34 +02:00			`![Screenshot of Jackett](./doc/screenshots/demo.png)`
Initial commit 2021-05-21 14:24:10 +02:00
			`## Documentation and resources`

Auto-update READMEs 2024-04-15 03:36:45 +02:00			`- Upstream app code repository: <https://github.com/Jackett/Jackett>`
			`- YunoHost Store: <https://apps.yunohost.org/app/jackett>`
			`- Report a bug: <https://github.com/YunoHost-Apps/jackett_ynh/issues>`
Initial commit 2021-05-21 14:24:10 +02:00
			`## Developer info`

Auto-update READMEs 2024-04-15 03:36:45 +02:00			Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/jackett_ynh/tree/testing).
Initial commit 2021-05-21 14:24:10 +02:00
Auto-update READMEs 2024-04-15 03:36:45 +02:00			To try the `testing` branch, please proceed like that:
Auto-update README 2022-05-27 14:36:34 +02:00
Auto-update READMEs 2024-04-15 03:36:45 +02:00			```bash
fixed name 2021-05-21 18:08:30 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug`
Initial commit 2021-05-21 14:24:10 +02:00			`or`
fixed name 2021-05-21 18:08:30 +02:00			`sudo yunohost app upgrade jackett -u https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug`
Initial commit 2021-05-21 14:24:10 +02:00			```

Auto-update READMEs 2024-04-15 03:36:45 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`