Files
hassio-addons/flexget/README.md
2025-11-06 16:50:01 +01:00

5.0 KiB

Hass.io Add-ons: Flexget

Donate Donate

Version Ingress Arch

Codacy Badge GitHub Super-Linter Builder

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

Stargazers repo roster for @alexbelgium/hassio-addons

downloads evolution

About

FlexGet is a multipurpose automation tool for all of your media. It can support torrents, NZBs, podcasts, comics, TV, movies, RSS, HTML, CSV, and more.

Key features:

  • Powerful plugin system with 300+ plugins
  • RSS feed processing and filtering
  • Integration with download clients
  • Web-based management interface
  • Scheduled execution and daemon mode

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

  1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA) Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.
  2. Install this add-on.
  3. Click the Save button to store your configuration.
  4. Set the add-on options to your preferences
  5. Start the add-on.
  6. Check the logs of the add-on to see if everything went well.
  7. Open the webUI and adapt the software options

Configuration

Use the add-on env_vars option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.

Webui can be found at http://homeassistant:5050. Default password: homeassistant123 (change via addon options).

Setup Steps

  1. Access the web interface after starting the addon
  2. Create or edit your FlexGet configuration file
  3. Set up RSS feeds and download sources
  4. Configure output plugins for your download clients
  5. Test configuration and enable scheduling

Options

Option Type Default Description
PGID int 0 Group ID for file permissions
PUID int 0 User ID for file permissions
WebuiPass str homeassistant123 Web interface password
FG_PLUGINS str Additional plugins to install
FG_LOG_LEVEL list Log level (critical/error/warning/info/verbose/debug/trace)

Example Configuration

PGID: 1000
PUID: 1000
WebuiPass: "SecurePassword123"
FG_PLUGINS: "flexget-plugins-extra"
FG_LOG_LEVEL: "info"

Configuration File

FlexGet uses a YAML configuration file located at /config/flexget/config.yml. Example:

tasks:
  tv-shows:
    rss: https://example.com/tv-shows.rss
    series:
      - Breaking Bad
      - Game of Thrones
    transmission:
      host: localhost
      port: 9091

For complete configuration documentation, see: https://flexget.com/Configuration

Support

If you have an issue with your installation, please be sure to checkout github.