Configuration

The flemzerd daemon loads its configuration file when starting. The configuration file is written in TOML and loaded from the following places:

• ~/.config/flemzerd/flemzerd.toml
• /etc/flemzerd/flemzerd.toml

The first file found is used as the configuration file. When starting, the flemzerd daemon displays in the logs the configuration file used.

Configuration files can be loaded from other places than the default directories listed above. To specify another configuration file, use the -d flag when starting flemzerd:

./flemzerd -c /path/to/config.toml

The configuration file is organized in different sections, each section corresponding to a specific subject.

[system]
    check_interval = 15
    healthcheck_interval = 5
    torrent_download_attempts_limit = 5
    track_shows = true
    track_movies = true
    automatic_movie_download = false
    automatic_show_download = true
    show_download_delay = 12
    movie_download_delay = 168
    preferred_media_quality = "720p"
    excluded_release_types = "cam,screener,telesync,telecine"

• check_interval (default: 15)
  flemzerd checks regularly for new movies and shows from watchlists and new episodes from tracked TV shows. This option sets the check interval (in minutes).
• healthcheck_interval (default: 5)
  flemzerd regularly checks the state of its modules (providers, indexers, notifiers, etc...). This option sets the healthcheck interval (in minutes).
• torrent_download_attempts_limit (default: 5)
  Failure to download torrent can happen. flemzerd waits by default for 5 torrent download failures before marking the download as failed. This options sets the number of download failures needed to consider the media download as failed
• track_shows (default: true)
  Track and download TV shows episodes found in Watchlists. Set to false to disable TV show handling.
• track_movies (default: true)
  Track and download movies found in Watchlists. Set to false to disable movies handling.
• automatic_movie_download (default: false)
  Download movies automatically as soon as added in flemzerd. If false, movie download will have to be triggered manually in the Web interface.
• automatic_show_download (default: true)
  Download episodes automatically as soon as added in flemzerd. If false, episode download will have to be triggered manually in the Web interface.
• show_download_delay (default: 12)
  Number of hours to wait before trying to download recently released episode (torrents may not be available immediately.
• movie_download_delay (default: 168 ~ 1 week)
  Number of hours to wait before trying to download recently released movie (torrents may not be available immediately.
• preferred_media_quality (default: 720p)
  When getting torrents for media, flemzerd can sort them by quality, putting the one you chose in this option first. Possible values are: 480p, 576p, 720p, 900p, 1080p, 1440p, 2160p, 5k, 8k, 16k
• excluded_release_types (default: cam, screener, telesync, telecine)
  When the following release types are detected in a torrent name, it will be excluded from download list. Possible values are: cam, screener, telesync, telecine, dvdrip, hdtv, webdl, blurayrip

[interface]
    enabled = true
    port = 8400
                                                                                                                                                                                                                            
    use_ssl = true                                                                                                                                                                                                           
    ssl_cert = "/var/lib/flemzerd/certs/cert.pem"                                                                                                                                                                                         
    ssl_server_key = "/var/lib/flemzerd/certs/privkey.pem"                                                                                                                                                                                
                                                                                                                                                                                                                              
    [interface.auth]                                                                                                                                                                                                         
        username = "admin"                                                                                                                                                                                                   
        password = "flemzerd"

• enabled (default: true)
  Enable web interface
• port (default: 8400)
  Access port to web interface
• use_ssl (default: true)
  Serve web interface via SSL
• ssl_cert (default: /var/lib/flemzerd/certs/cert.pem)
  Path to SSL cert. By default, flemzerd comes with self signed certificates. Those should be changed when possible with real certificates.
• ssl_server_key (default: /var/lib/flemzerd/certs/privkey.pem)
  Path to SSL server key
• Authentication:
  • username (default: admin)
    Username used to log into the web interface
  • password (default: flemzerd)
    Password used to log into the web interface. This should be changed and caused a configuration error displayed in the web interface if the default value is used.

[providers]
    [providers.provider1]
        key1 = "value"
        key2 = 1

For flemzerd to work, all used modules, including providers must be declared. This section is a list of the different Providers to use. Each Provider defines a subsection of [providers], and each subsection of [providers] must be an exisiting Provider with its configuration keys.

See more details about available Providers in the associated documentation page: Providers

[notifiers]
    notifier1 = []
    notifier2 = []

    [notifiers.notifier3]
        key1 = "value"
        key2 = 1

Notifiers used by the flemzerd daemon are defined in the [notifiers] section. Using notifiers is optional, so this section can be left empty of even not declared at all in the configuration file. Each Notifier defines a subsection of [notifiers], and each subsection of [notifiers] must be an exisiting Notifier with its configuration keys.

See more details about available Notifiers in the associated documentation page: Notifiers

[indexers]
    [[indexers.indexer1]]
        key1 = "value"
        key2 = 1

    [[indexers.indexer2]]
        key1 = "value"
        key2 = 1

Indexers used in the flemzerd daemon are defined in the [indexers] section. Each Indexer defines a subsection of [indexers], and each subsection of [indexers] must be an exisiting Indexer with its configuration keys.

See more details about available Indexers in the associated documentation page: Indexers

[downloaders]
    [downloaders.downloader1]
        key1 = "value"
        key2 = 1

Downloaders used in the flemzerd daemon are defined in the [downloaders] section. Each Downloader defines a subsection of [downloaders], and each subsection of [downloaders] must be an exisiting Downloader with its configuration keys. While multiple Downloaders can be defined and loaded into flemzerd, only the first Downloader available will be used for downloading torrents.

See more details about available Downloaders in the associated documentation page: Downloaders

[watchlists]
    watchlist1 = []
    watchlist2 = [
        "TV_SHOW_1",
        "TV_SHOW_2",
        "TV_SHOW_3"
    ]

Watchlists used in the flemzerd daemon are defined in the [watchlists] section. Each watchlist defines a subsection of [watchlists], and each subsection of [watchlists] must be an exisiting Watchlist with its configuration keys.

See more details about available Watchlists in the associated documentation page: Watchlists

[mediacenters]
    [mediacenters.mediacenter1] 
        key1 = "value"
        key2 = 1

Mediacenters used in the flemzerd daemon are defined in the [mediacenters] section. Each mediacenter defines a subsection of [mediacenters], and each subsection of [mediacenters] must be an exisiting mediacenter with its configuration keys.

See more details about available Mediacenters in the associated documentation page: Mediacenters

[notifications]
    enabled = true
    notify_new_episode = true
    notify_new_movie = true
    notify_download_start = true
    notify_download_complete = true
    notify_failure = true

• enabled (default: true)
  Global state of notifications. If set to false, no notifications will be sent, even if the others parameters in the [notifications] section are set to true
• notify_new_episode (default: true)
  If set to true, send notification when a new episode from tracked shows has aired recently.
• notify_new_movie (default: true)
  If set to true, send notification when a new movie has been found in Watchlists
• notify_download_start (default: true)
  If set to true, send notification when a media download starts.
• notify_download_complete (default: true)
  If set to true, send notification when a media download has ended successfully
• notify_failure (default: true)
  If set to true, send notification when a media download failed

[library]
    show_path = "/var/lib/flemzer/library/shows"
    movie_path = "/var/lib/flemzer/library/movies"
    custom_tmp_dir = "/var/lib/flemzerd/tmp"

When downloading media, you can choose where flemzerd will put downloaded content. This can be useful if you have a predefined place where you put your media (mediacenter library for example).

The flemzerd daemon also uses a temporary folder when downloading items. This prevents your library to be filled with incomplete downloads or useless files created by an unsuccessful torrent download.

• show_path (default var/lib/flemzer/library/shows)
  Path where downloaded TV show episodes will be placed
• movie_path (default var/lib/flemzer/library/movies)
  Path where downloaded movies will be placed
• custom_tmp_dir (default var/lib/flemzerd/tmp)
  Path where in progress downloads will be placed