Skip to content

Latest commit

 

History

History
207 lines (179 loc) · 9.68 KB

supported.md

File metadata and controls

207 lines (179 loc) · 9.68 KB
Raw
title description published date tags editor dateCreated
Whisparr Supported
true
2022-03-18 08:29:26 UTC
markdown
2021-06-23 07:55:24 UTC

Table of Contents

This page is a work in progress and requires additional effort.{.is-warning}

This page is the disambiguation page for all supported wiki links (i.e. typically "more info" in the UI).

Download Clients

{#downloadclient}

Indexers

{#indexer}

Usenet

  • Newznab {#newznab}
    • Refer to the Settings Page
    • Newznab is a standardized API used by many usenet indexing sites. Many presets are available, but all require an API key to be accessible.
    • Indexer Applications like Prowlarr and NZBHydra2 can provide advanced capabilities such as stat tracking.
  • omgwtfnzbs {#omgwtfnzbs}

Torrents

  • FileList {#filelist}
  • HDBits {#hdbits}
  • IP Torrents {#iptorrents}
    • Private Tracker

    IP Torrents' native implementation does not support Search {.is-info}

  • Nyaa {#nyaa}
    • Torrent Tracker for Japanese Media (Anime) exclusively.

    Nyaa frowns upon automation and frequently will ban your IP. {.is-info}

  • Pass The Popcorn (PTP) {#passthepopcorn}
  • Torrent RSS Feed {#torrentrssindexer}
    • Generic torrent RSS feed parser.

    The RSS feed must contain a pubdate. The release size is recommended as well. {.is-info}

  • TorrentPotato {#torrentpotato}
  • Torznab {#torznab}
    • Torznab is a wordplay on Torrent and Newznab. It uses the same structure and syntax as the Newznab API specification, but exposing torrent-specific attributes and .torrent files. Thus supports a recent RSS feed AND backlog searching capabilities. The specification is not maintained nor supported by the Newznab organization. (The same API specification is shared with nZEDb)
    • This is primarily only supported by Prowlarr and Jackett
    • Refer to the Settings Page

Many torrent trackers thrive on the community and may have rules in place that mandate site visits, karma, votes, comments, etc. Please review your tracker rules and etiquette, keep your community alive. We're not responsible if your account is banned for disobeying rules or accruing Hit and Runs (HnRs)/low-ratio. {.is-warning}

Notifications

{#notification}

  • Boxcar {#boxcar}
  • Custom Script {#customscript}
    • This allows you to make a custom script for when a particular action happens this script will run. See Custom Scripts for more details.
  • Discord {#discord}
    • By far one of the most common ways to push notifications of actions happening on your Whisparr
  • Email {#email}
    • Simply send yourself or somebody you want to annoy with email. If you're using Gmail, you need to enable less secure apps. If you're using Gmail and have 2-factor authentication enabled you need to use an App Specific password.

You can use a "pretty address" like SomePrettyName <email@example.org> {.is-info}

  • Emby {#mediabrowser}
  • Gotify {#gotify}
  • Join {#join}
  • Kodi {#xbmc}
    • Kodi spawned from the love of media. It is an entertainment hub that brings all your digital media together into a beautiful and user friendly package. It is 100% free and open source, very customizable and runs on a wide variety of devices. It is supported by a dedicated team of volunteers and a huge community. By adding Kodi as a connection you can update Kodi's library when a new movie has been added to Whisparr.
  • Mailgun {#mailgun}
  • Notifiarr {#notifiarr}
  • Plex Media Server {#plexserver}
    • The server for your self hosted Plex system, Enabling this is much like Kodi will allow you to push an update to your plex server notifying it that a new/upgraded movie is available.
    • This is rarely needed and is only required if Plex is unable to watch the file system for changes.
    • In the handful of situations where Plex is unable to watch the file system using ionotift - such as certain types of remote mounts and a handful of older network mounts - it is suggested to use the app plexautoscan rather than the Plex connection

Note that this may trigger a full library scan for the library/root folder the movie is in. It is strongly suggested to use the native Plex functionality that just watches the file system or to use a tool like plexautoscan {.is-warning}

  • Prowl {#prowl}
  • Pushbullet {#pushbullet}
  • Pushover {#pushover}
  • SendGrid {#sendgrid}
  • Slack {#slack}
  • Synology Indexer {#synologyindexer}
  • Telegram {#telegram}
  • Trakt {#trakt}
  • Twitter {#twitter}
  • Webhook {#webhook}

Lists

{#importlist}

  • CouchPotato {#couchpotatoimport}

  • Custom Lists {#whisparrlistimport}

  • IMDb Lists {#imdblistimport}

    • To add your IMDb Watchlist, go to your list and click edit. Make sure privacy setting is set to public. In the address bar you will find the lsxxxxxx number that you will need to enter into Whisparr

      1. Go to your IMDB List Settings
      2. Ensure Privacy is set to Public (i.e. Disabled)
      3. Use the ls number within the URL

  • imdb-list-ls.png

  • Whisparr {#whisparrimport}

    • TRaSH has a guide for syncing two instances

  • RSS List {#rssimport}

  • StevenLu Custom {#stevenluimport}

  • StevenLu List {#stevenlu2import}

  • TMDb Collection {#tmdbcollectionimport}

  • TMDb Company {#tmdbcompanyimport}

  • TMDb Keyword {#tmdbkeywordimport}

  • TMDb List {#tmdblistimport}

  • TMDb Person {#tmdbpersonimport}

  • TMDb Popular {#tmdbpopularimport}

  • TMDb User {#tmdbuserimport}

  • Trakt List {#traktlistimport}

    • Username - Ensure you enter the actual username of the user and not the user's name
    • List - Ensure you use the list name as presented in the list URL
    • Example: https://trakt.tv/users/some-user-name/lists/trakt-list-name?sort=rank,asc
      • Username: some-user-name
      • List: trakt-list-name

  • Trakt Popular List {#traktpopularimport}

  • Trakt User {#traktuserimport}

    • This type should be used when using your own watchlist

Metadata

{#metadata}

  • Emby (Legacy) {#mediabrowsermetadata}
    • Enable - Enable metadata file creation for this metadata type
    • Movie Metadata - Enable metadata file creation for this metadata type
  • Kodi (XBMC) / Emby {#xbmcmetadata}
    • Enable - Enable metadata file creation for this metadata type
    • Movie Metadata - Create a <filename>.nfo with the movie metadata
    • (Advanced Option) Movie Metadata URL - Create movie.nfo with TMDb and IMDb movie URLs
    • Metadata Language - Select the language Whisparr should use to write the metadata if available in that language
    • Movie Images - Create various Season images including posters and banners
    • Use Movie.nfo - Write the nfo file as movie.nfo rather than the default
  • Roksbox {#roksboxmetadata}
    • Enable - Enable metadata file creation for this metadata type
    • Movie Metadata - Create xml file for each movie
    • Movie Images - Create Movie.jpg
  • WDTV {#wdtvmetadata}
    • Enable - Enable metadata file creation for this metadata type
    • Movie Metadata - Create <filename>.xml for each episode
    • Movie Images - Create folder.jpg