/addon-jackett

Jackett addon fro Hassio

Primary LanguageLuaMIT LicenseMIT

Hass.io Add-on: Jackett Proxy Server

Jackett Logo

About

You can use this add-on to install Jackett, which is an open-source indexer scraper. Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar, Lidarr, DuckieTV, qBittorrent, Nefarious etc) into tracker-site-specific http queries. For more information, please see Jackett.

Installation

The installation of this add-on is straightforward and easy to do.

  1. Navigate in your Home Assistant frontend to Hass.io -> Add-on Store.
  2. Add the Hass.io add-on repository https://github.com/Sabuto/hassio-repo/.
  3. Install the "Jackett" add-on.

How to use

To get the add-on running:

  1. Start the add-on.
  2. Have some patience and wait a couple of minutes.
  3. Check the add-on log output to see the result.

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration, with all available options:

{
  "black_hole": "/share/blackhole"
}

Note: This should only be changed if you need the torrent files to be saved in a different location.

The url to use in sonarr and other tool is not the one displayed in jackett, instead use it like: HASSIO_IP:8889

Option: black_hole

The black_hole option controls the location of saved torrent files. It can be set to share, config or ssl folders.

Option: api_key

The api_key option allow you to set a permanent api key that will not change.

Support

In case you've found a bug, please open an issue on our GitHub [issue].

There has been reports of the Web UI not loading on some set-ups. This is caused from the browser blocking an API call to home assistant. If you open the browser console and find the blocked URL and manual amend it to HTTPS the add-on functions as it should. If this doesn't fix it for you, open an [issue].

License

MIT License Copyright (c) 2019 Robert Dunne

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.