avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-10 09:51:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Claudify

Browse Source
This commit is contained in:
Alexandre
2025-08-01 22:39:32 +02:00
parent 294dd7c52c
commit f4a1f85fd1
7 changed files with 387 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
autobrr/README.md
View File

@@ -46,24 +46,57 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration
---
Webui can be found at <http://homeassistant:7474> or through Ingress.
Default credentials: `admin` / `password` (change after first login).
Webui can be found at <http://homeassistant:PORT>.
The default username/password : described in the startup log.
Configurations can be done through the app webUI, except for the following options
### Setup Steps
1. Access the web interface after starting the addon
2. Change default login credentials
3. Configure RSS indexers and download clients
4. Set up automation rules and filters
5. Test with sample releases
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `PGID` | int | `0` | Group ID for file permissions |
| `PUID` | int | `0` | User ID for file permissions |
| `TZ` | str | | Timezone (e.g., `Europe/London`) |
| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1`) |
| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) |
| `cifsusername` | str | | SMB username for network shares |
| `cifspassword` | str | | SMB password for network shares |
| `cifsdomain` | str | | SMB domain for network shares |
### Example Configuration
```yaml
PGID: user
GPID: user
TZ: timezone
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
cifsusername: "username" # optional, smb username, same for all smb shares
cifspassword: "password" # optional, smb password
WEBUI_USERNAME: webui username
WEBUI_PASSWORD: password
PGID: 1000
PUID: 1000
TZ: "Europe/London"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/downloads"
cifsusername: "dluser"
cifspassword: "password123"
cifsdomain: "workgroup"
```
### Mounting Drives
This addon supports mounting both local drives and remote SMB shares:
- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons)
### Custom Scripts and Environment Variables
This addon supports custom script execution and environment variable injection:
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
## Support
Create an issue on github

67
filebrowser/README.md
View File

@@ -22,15 +22,31 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
## About
Web based [File Browser](https://filebrowser.org/).
This addon is based on the [docker image](https://hub.docker.com/r/filebrowser/filebrowser) from filebrowser.
Web-based file management interface that provides a secure way to browse, upload, download, edit and manage files on your Home Assistant system. Filebrowser offers a clean, modern interface for handling your files through a web browser, with support for multiple file formats, preview capabilities, and comprehensive file operations.
This addon is based on the [docker image](https://hub.docker.com/r/filebrowser/filebrowser) from the official Filebrowser project.
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on.
1. [Add my Home Assistant add-ons repository][repository] to your Home Assistant instance.
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Access the web UI through the sidebar or at `<your-ip>:8071`.
## Configuration
Webui can be found at <http://homeassistant:port> or through the sidebar using Ingress.
Default username: "admin" and password: "admin"
The web UI can be found at `<your-ip>:8071` or through the Home Assistant sidebar when using Ingress.
Network disk is mounted to `/share/storagecifs`.
**Default credentials:**
- Username: `admin`
- Password: `admin`
**Important:** Change the default credentials immediately after first login for security.
### Options
@@ -40,13 +56,13 @@ Network disk is mounted to `/share/storagecifs`.
| `certfile` | str | `fullchain.pem` | SSL certificate file (in `/ssl/`) |
| `keyfile` | str | `privkey.pem` | SSL private key file (in `/ssl/`) |
| `NoAuth` | bool | `true` | Disable authentication (resets database when changed) |
| `disable_thumbnails` | bool | `true` | Disable thumbnail generation for speed |
| `base_folder` | str | `/` | Root folder for file browser |
| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) |
| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) |
| `cifsusername` | str | | SMB username for network shares |
| `cifspassword` | str | | SMB password for network shares |
| `cifsdomain` | str | | SMB domain for network shares |
| `disable_thumbnails` | bool | `true` | Disable thumbnail generation for improved performance |
| `base_folder` | str | *(optional)* | Root folder for file browser (defaults to all mapped folders) |
| `localdisks` | str | *(optional)* | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) |
| `networkdisks` | str | *(optional)* | SMB shares to mount (e.g., `//SERVER/SHARE`) |
| `cifsusername` | str | *(optional)* | SMB username for network shares |
| `cifspassword` | str | *(optional)* | SMB password for network shares |
| `cifsdomain` | str | *(optional)* | SMB domain for network shares |
### Example Configuration
@@ -64,6 +80,17 @@ cifspassword: "password123"
cifsdomain: "workgroup"
```
## Setup
1. Start the add-on and wait for it to initialize.
1. Access the web interface through the Home Assistant sidebar or at `<your-ip>:8071`.
1. Log in using the default credentials:
- Username: `admin`
- Password: `admin`
1. **Important:** Immediately change the default password by clicking on "Settings" > "User Management".
1. Configure your preferred settings through the web interface.
1. If authentication is disabled (`NoAuth: true`), the login screen will be bypassed.
### Mounting Drives
This addon supports mounting both local drives and remote SMB shares:
@@ -78,25 +105,11 @@ This addon supports custom scripts and environment variables through the `addon_
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. [![Add repository on my Home Assistant][repository-badge]][repository-url]
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the [official documentation](https://filebrowser.org/configuration) for for that.
## Support
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-filebrowser/282108/3).
Create an issue on GitHub, or ask on the [Home Assistant Community thread](https://community.home-assistant.io/t/home-assistant-addon-filebrowser/282108/3).
[repository]: https://github.com/alexbelgium/hassio-addons
[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg

60
flaresolverr/README.md
View File

@@ -23,29 +23,63 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
## About
FlareSolverr starts a proxy server and it waits for user requests in an idle state using few resources. When some request arrives, it uses puppeteer with the stealth plugin to create a headless browser (Firefox). It opens the URL with user parameters and waits until the Cloudflare challenge is solved (or timeout). The HTML code and the cookies are sent back to the user, and those cookies can be used to bypass Cloudflare using other HTTP clients.
[FlareSolverr](https://github.com/FlareSolverr/FlareSolverr) is a proxy server to bypass Cloudflare protection. It starts a proxy server that waits for user requests in an idle state using few resources. When a request arrives, it uses Puppeteer with the stealth plugin to create a headless browser (Firefox) that solves Cloudflare challenges.
NOTE: Web browsers consume a lot of memory. If you are running FlareSolverr on a machine with few RAM, do not make many requests at once. With each request a new browser is launched.
Key features:
- Bypasses Cloudflare protection automatically
- Headless browser automation with Firefox
- RESTful API for integration with other tools
- Cookie extraction for subsequent requests
- Support for various Cloudflare challenge types
Project homepage : https://github.com/FlareSolverr/FlareSolverr
Based on the docker image : https://hub.docker.com/r/flaresolverr/flaresolverr
## Configuration
Webui can be found at <http://homeassistant:port>
**Note**: Web browsers consume significant memory. Avoid making many concurrent requests on systems with limited RAM.
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
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.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
## Configuration
Web interface can be found at <http://homeassistant:8191>.
This addon has no configuration options - it works out of the box.
### API Usage
FlareSolverr provides a REST API for integration with other applications:
**Endpoint**: `http://homeassistant:8191/v1`
**Example Request**:
```json
{
"cmd": "request.get",
"url": "https://example.com",
"maxTimeout": 60000
}
```
### Integration with *arr Apps
Configure your indexers to use FlareSolverr:
- **Prowlarr/Jackett**: Set FlareSolverr URL to `http://homeassistant:8191`
- **Sonarr/Radarr**: Configure indexers to use the FlareSolverr proxy
### Options
No configuration options are available - FlareSolverr works automatically with default settings.
### Resource Requirements
- **Memory**: 512MB+ recommended
- **CPU**: Moderate usage during challenge solving
- **Network**: Requires internet access to function
## Support

81
flexget/README.md
View File

@@ -22,24 +22,79 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
## About
FlexGet is a multipurpose automation tool for all of your media. See https://flexget.com/
[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.
Default password is 'homeassistant123' , or can be set from the addons options
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
## Requirements
## Installation
## Config
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
"PUID": custom user (default root)
"PGID": custom user (default root)
"WebuiPass": webui password définition
"FG_PLUGINS": Plugins addition
"FG_LOG_LEVEL": Log level (critical|error|warning|info|verbose|debug|trace)
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.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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
## Start
## Configuration
- Start the addon. Wait a while and check the log for any errors.
Webui can be found at <http://homeassistant:5050>.
Default password: `homeassistant123` (change via addon options).
## Troubleshooting
### Setup Steps
If you have in issue with your installation, please be sure to checkout github.
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.

112
linkwarden/README.md
View File

@@ -1,5 +1,5 @@
# Home assistant add-on: linkwarden
# Home assistant add-on: Linkwarden
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
@@ -23,69 +23,97 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
## About
---
[Linkwarden](https://linkwarden.app/) is a collaborative bookmark manager to collect, organize, and preserve webpages and articles. It allows teams and individuals to save, categorize, and manage bookmarks with features like tags, collections, and full-text search capabilities.
[linkwarden](https://linkwarden.app/) is a collaborative bookmark manager to collect, organize, and preserve webpages and articles.
This addon is based on their docker image.
This addon is based on the [official Linkwarden Docker image](https://github.com/linkwarden/linkwarden).
## Configuration
Install, then start the addon a first time
Webui can be found at <http://homeassistant:3000>.
You'll need to create a new user at startup.
Webui can be found at `<your-ip>:3000` or through the sidebar using Ingress.
You'll need to create a new user account at startup.
Options can be configured through two ways :
### Options
- Addon options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `NEXTAUTH_SECRET` | str | **Required** | Secret key for NextAuth.js authentication (must be filled at start) |
| `NEXTAUTH_URL` | str | | Custom NextAuth URL (optional, only if Linkwarden is kept externally) |
| `NEXT_PUBLIC_DISABLE_REGISTRATION` | bool | `false` | Disable new user registration |
| `NEXT_PUBLIC_CREDENTIALS_ENABLED` | bool | `true` | Enable username/password login |
| `STORAGE_FOLDER` | str | `/config/library` | Directory for storing data files |
| `DATABASE_URL` | str | | External PostgreSQL database URL (leave blank for internal database) |
| `NEXT_PUBLIC_AUTHENTIK_ENABLED` | bool | `false` | Enable Authentik SSO integration |
| `AUTHENTIK_CUSTOM_NAME` | str | `Authentik` | Custom provider name for Authentik button |
| `AUTHENTIK_ISSUER` | str | | Authentik OpenID Configuration Issuer URL |
| `AUTHENTIK_CLIENT_ID` | str | | Client ID from Authentik Provider Overview |
| `AUTHENTIK_CLIENT_SECRET` | str | | Client Secret from Authentik Provider Overview |
| `NEXT_PUBLIC_OLLAMA_ENDPOINT_URL` | str | | Ollama endpoint URL for AI features |
| `OLLAMA_MODEL` | str | | Ollama model name for AI processing |
### Example Configuration
```yaml
"NEXTAUTH_SECRET": mandatory, must be filled at start
"NEXTAUTH_URL": optional, only if linkwarden is kept externally
"NEXT_PUBLIC_DISABLE_REGISTRATION": If set to true, registration will be disabled.
"NEXT_PUBLIC_CREDENTIALS_ENABLED": If set to true, users will be able to login with username and password.
"STORAGE_FOLDER": optional, is /config/library by default
"DATABASE_URL": optional, if kept blank an internal database will be used. If an external database is used, modify according to this design postgresql://postgres:homeassistant@localhost:5432/linkwarden
"NEXT_PUBLIC_AUTHENTIK_ENABLED": If set to true, Authentik will be enabled and you'll need to define the variables below.
"AUTHENTIK_CUSTOM_NAME": Optionally set a custom provider name. (name on the button)
"AUTHENTIK_ISSUER": This is the "OpenID Configuration Issuer" shown in the Provider Overview. Note that you must delete the "/" at the end of the URL. Should look like: `https://authentik.my-doma.in/application/o/linkwarden`
"AUTHENTIK_CLIENT_ID": Client ID copied from the Provider Overview screen in Authentik
"AUTHENTIK_CLIENT_SECRET": Client Secret copied from the Provider Overview screen in Authentik
NEXTAUTH_SECRET: "your-very-long-secret-key-here-at-least-32-characters"
NEXT_PUBLIC_DISABLE_REGISTRATION: false
NEXT_PUBLIC_CREDENTIALS_ENABLED: true
STORAGE_FOLDER: "/config/library"
DATABASE_URL: "postgresql://postgres:homeassistant@localhost:5432/linkwarden"
NEXT_PUBLIC_AUTHENTIK_ENABLED: false
AUTHENTIK_CUSTOM_NAME: "My Authentik"
AUTHENTIK_ISSUER: "https://authentik.my-domain.com/application/o/linkwarden"
AUTHENTIK_CLIENT_ID: "your-client-id"
AUTHENTIK_CLIENT_SECRET: "your-client-secret"
```
- Config.yaml
All other options can be configured using the config.yaml file found in /config/db21ed7f_filebrowser/config.yaml using the Filebrowser addon.
### Setup Steps
The complete list of options can be seen here : https://docs.linkwarden.app/self-hosting/environment-variables
1. **First Time Setup**: After starting the addon, visit the web interface and create your first user account
2. **NEXTAUTH_SECRET**: Generate a secure random string (at least 32 characters) for the `NEXTAUTH_SECRET` option
3. **Database**: By default, Linkwarden uses an internal SQLite database. For production use, consider setting up PostgreSQL
4. **Authentication**: Configure Authentik integration if you want SSO capabilities
5. **Storage**: Bookmark data and files are stored in the configured `STORAGE_FOLDER`
### Custom Scripts and Environment Variables
This addon supports custom scripts and environment variables through the `addon_config` mapping:
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
### Authentik Integration
To integrate with Authentik for Single Sign-On:
1. Follow the instructions from the [Linkwarden documentation](https://docs.linkwarden.app/self-hosting/sso-oauth#authentik)
2. Set `NEXT_PUBLIC_AUTHENTIK_ENABLED` to `true`
3. Configure the Authentik-specific options with values from your Authentik Provider Overview
4. Note: Remove the trailing "/" from the `AUTHENTIK_ISSUER` URL
### Additional Configuration
For advanced configuration options, refer to the complete list of environment variables in the [Linkwarden documentation](https://docs.linkwarden.app/self-hosting/environment-variables).
## Installation
---
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
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.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. [![Add repository on my Home Assistant][repository-badge]][repository-url]
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Set the add-on options to your preferences
1. Set the `NEXTAUTH_SECRET` option to a secure random string.
1. Configure other options as needed.
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
## Integration with Authentik
Follow the instruction from the Linkwarden docs page. https://docs.linkwarden.app/self-hosting/sso-oauth#authentik
## Common issues
<details>
1. Open the webUI and create your first user account.
## Support
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-linkwarden/279247)
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-linkwarden/279247).
[repository]: https://github.com/alexbelgium/hassio-addons
[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons
---

73
tdarr/README.md
View File

@@ -22,15 +22,34 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
## About
[Tdarr](https://tdarr.io) is a closed-source distributed transcoding system for automating media library transcode/remux management and making sure your files are exactly how you need them to be in terms of codecs/streams/containers and so on. Put your spare hardware to use with Tdarr Nodes for Windows, Linux (including Linux arm) and macOS.
[Tdarr](https://tdarr.io) is a distributed transcoding system for automating media library transcode/remux management using FFmpeg/HandBrake. It ensures your files are exactly how you need them to be in terms of codecs, streams, and containers. Tdarr supports distributed processing, allowing you to put your spare hardware to use with Tdarr Nodes for Windows, Linux (including ARM), and macOS.
Key features:
- Distributed transcoding across multiple nodes
- Automated media library management
- Support for FFmpeg and HandBrake
- Hardware acceleration support
- Web-based management interface
- Plugin-based workflow system
This addon is based on the [docker image](https://hub.docker.com/r/hurlenko/Tdarr) from hurlenko.
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for that.
## Configuration
Webui can be found at <http://homeassistant:8265> or through the sidebar using Ingress.
App documentation can be found here: https://docs.tdarr.io/docs/welcome/what/
Configurations can be done through the app webUI, except for the following options.
Web UI can be found at `<your-ip>:8265` or through the sidebar using Ingress.
The server port is `8266` for connecting external Tdarr nodes.
### Options
@@ -56,6 +75,23 @@ cifspassword: "password123"
cifsdomain: "workgroup"
```
### Setting up Distributed Transcoding
1. **Configure the Server**:
- Access the Web UI at `<your-ip>:8265`
- Set up your media libraries and transcoding settings
- Configure plugins and workflows as needed
2. **Add External Nodes**:
- Install Tdarr Node on additional machines
- Point them to your Home Assistant IP on port `8266`
- Nodes will automatically register and appear in the Web UI
3. **Hardware Acceleration**:
- The addon includes hardware acceleration support
- Configure GPU transcoding in the Tdarr Web UI settings
- Supported acceleration: Intel QuickSync, NVIDIA NVENC, AMD VCE
### Mounting Drives
This addon supports mounting both local drives and remote SMB shares:
@@ -63,23 +99,26 @@ This addon supports mounting both local drives and remote SMB shares:
- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons)
## Installation
### Custom Scripts and Environment Variables
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
This addon supports custom scripts and environment variables through the `addon_config` mapping:
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
### Hardware Acceleration Notes
The addon includes device access for hardware acceleration:
- Intel QuickSync: `/dev/dri` devices are mapped
- NVIDIA: Environment variables are set for GPU detection
- AMD: Hardware acceleration supported through available devices
Configure hardware acceleration in the Tdarr Web UI under Settings > FFmpeg/HandBrake settings.
## Support
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-Tdarr/282108/3)
- Official Tdarr documentation: [https://docs.tdarr.io/](https://docs.tdarr.io/)
- Create an issue on [GitHub](https://github.com/alexbelgium/hassio-addons/issues)
- Ask on the [Home Assistant Community thread](https://community.home-assistant.io/t/home-assistant-addon-tdarr/282108/3)
[repository]: https://github.com/alexbelgium/hassio-addons
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg

61
unpackerr/README.md
View File

@@ -46,7 +46,66 @@ The installation of this add-on is pretty straightforward and not different in c
## Configuration
No webui.
This addon has no web interface - it runs as a background service.
Unpackerr monitors completed downloads and extracts archives automatically.
### Setup Steps
1. Configure your download client to save completed downloads to the extraction path
2. Set the watch path where extracted files should be placed
3. Configure *arr apps to monitor the watch path for imports
4. Start the addon and monitor logs for activity
### Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `PGID` | int | `1000` | Group ID for file permissions |
| `PUID` | int | `1000` | User ID for file permissions |
| `TZ` | str | | Timezone (e.g., `Europe/London`) |
| `extraction_path` | str | `/share/downloads_packed` | Path where downloaded archives are located |
| `watch_path` | str | `/share/downloads_unpacked` | Path where extracted files are placed |
| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1`) |
| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) |
| `cifsusername` | str | | SMB username for network shares |
| `cifspassword` | str | | SMB password for network shares |
| `cifsdomain` | str | | SMB domain for network shares |
### Example Configuration
```yaml
PGID: 1000
PUID: 1000
TZ: "Europe/London"
extraction_path: "/share/downloads/completed"
watch_path: "/share/downloads/extracted"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/downloads"
cifsusername: "dluser"
cifspassword: "password123"
cifsdomain: "workgroup"
```
### Integration with *arr Apps
Configure your applications to use the appropriate paths:
- **Download clients**: Save completed downloads to `extraction_path`
- **Sonarr/Radarr/Lidarr**: Monitor `watch_path` for imports
- **File structure**: Maintain consistent folder structures
### Mounting Drives
This addon supports mounting both local drives and remote SMB shares:
- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons)
### Custom Scripts and Environment Variables
This addon supports custom script execution and environment variable injection:
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
In /addon_configs/db21ed7f_unpackerr/unpackerr.conf you can set all variables according to this list of environment variables : https://github.com/davidnewhall/unpackerr