Skip to content
This repository was archived by the owner on Aug 22, 2021. It is now read-only.

Providers

Mathieu Carrié edited this page Sep 21, 2019 · 1 revision

Providers overview

Providers role

flemzerd uses Providers to get detailed informations about media. The most important information from Providers is the release date. It allows flemzerd to launch detect new episodes and movies.

flemzerd also uses Providers modules to get a lot of details for the UI: plot details, pictures, episodes and season list...

Different providers types

Providers are external services such as TheMovieDB or TheTVDB that collect all these precious informations. Since some sites are sometimes specialized, flemzerd defines two types of Providers:

  • TV Providers: retrieve informations for TV shows and episodes
  • Movie Providers: retrieve informations for movies.

Providers can be TV Providers and Movie Providers at the same time. For example, The TVDB Provider is only a TV Provider because TheTVDB only provides information for TV shows. The TMDB Provider is a TV and Movie Provider because TheMovieDB contains informations about both media types.

Available Providers

The Providers used by the flemzerd daemon are defined in the configuration file. In this configuration file, multiple you can define multiple Providers with the following constraints:

  • If TV Shows tracking is enabled, you must define at least one TV Provider.
  • If movie tracking is enabled, you must define at least one Movie Provider.

You can also define multiple Providers of the same type. flemzerd uses the additional Providers as backups.

TheMovieDB

Type: TVProvider, MovieProvider

Uses TheMovieDB to get movies and TV shows informations.

How to use

  • Enable tmdb Provider in configuration file
[providers]
    tmdb = []
  • Define TMDB API key TMDB needs an key to perform API requests. This key is passed to flemzerd by defining the FLZ_TMDB_API_KEY environment variable. When defined during flemzerd compilation, this variable is compiled into the binary. In packages found on GitHub, this key is precompiled into the binary.

TheTVDB

Type: TVProvider

Uses TheTVDB to get TV shows informations.

How to use

  • Enable tvdb Provider in configuration file
[providers]
    tvdb = []
  • Define TMDB API key TVDB needs an key to perform API requests. This key is passed to flemzerd by defining the FLZ_TVDB_API_KEY environment variable. When defined during flemzerd compilation, this variable is compiled into the binary. In packages found on GitHub, this key is precompiled into the binary.

Clone this wiki locally

⌂ 换网址