mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
112 lines
5.5 KiB
Markdown
112 lines
5.5 KiB
Markdown
# Hass.io Add-ons: Flexget
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
[FlexGet](https://flexget.com/) 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)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. 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
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```yaml
|
|
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.
|
|
|
|
|