Skip to content

Latest commit

 

History

History
77 lines (42 loc) · 3.9 KB

DOCS.md

File metadata and controls

77 lines (42 loc) · 3.9 KB

Home Assistant Add-on: Transmission

Installation

Like other addons:

  1. Add this repository to your Add-on Store using the link below. (Or manually add the repository https://github.com/maorcc/hassio-addon-transmission to your Home Assistant add-ons repositories list.)

Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.

  1. Find the "Transmission" add-on in the Home Assistant Add-on Store. Click on it, and click on the "INSTALL" button.

  2. Turn on the Show in sidebar and Start on boot options.

Configuration

The Settings.json file

The Transmission settings are stored in the settings.json file that is located in the addon_config directory.

Two ways to change Transmission settings:

  1. Most Transmission settings can be modified via the Transmission web UI. (Recommended)

  2. Edit the settings.json file manually but only while the add-on is not running. Because on Transmission shutdown all the settings are automatically saved from memory. (Security related settings cannot be changed in the web UI.)

For full documentation on Transmission settings see the Transmission Docs.

⚠️ IMPORTANT

Changes to the settings.json file should only be done when the add-on is stopped. Otherwise your changes will be discarded.

The default settings

Transmission would work fine with the default settings. But you can change the settings to your needs.

The default values in settings.json are similar to the default values that are described in the official Transmission Docs, except for the following defaults:

  1. rpc-whitelist="172.30.32.2". Do not change this value as this is the internal home assistant docker IP address.

  2. rpc-host-whitelist-enabled=false. You can enable this if you also set the "rpc-host-whitelist" option to your Home Assistant host name.

  3. download-dir="/share/download". This is where Transmission will put the files it downloads. You can set it to any directory either under "/media" or under "/share".

How to Use

The "Transmission" easy-to-use web UI is available on the Home Assistant sidebar.

If you do not see it on the sidebar, make sure the addon is running and that you have turned on the "Show in sidebar" option on the Add-on page.

You will find the files you downloaded with Transmission in "/share/download" (That is unless you have changed the download-dir settings)

If you like this add-on, please ⭐ it on github. Thank you! 🙏

Support

Got questions?

You have several options to get them answered:

In case you've found a bug, please open an issue on our GitHub.

To check what is the latest version of Transmission that can be supported by this addon, check what is the latest Alpine version that is supported by Home Assistant Docker-Base, then check in alpinelinux.org what version of Transmission is supported by that Alpine.