Skip to content

marciogranzotto/addon-transmission-nas

 
 

Repository files navigation

This is a fork that supports mounting network drives through Samba Share

GitHub Release License

Supports armhf Architecture Supports armv7 Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Project Maintenance GitHub Activity

Buy me a coffee

If you want to mount an USB drive on Home Assistant and share it on the network, check out Samba NAS Add-On by dianlight

PROTECTION MODE NEEDS TO BE DISABLED FOR NETWORK DRIVES TO WORK

Transmission NAS addon for Home Assistant

The torrent client for Home Assistant with OpenVPN and Samba Share support.

Logo

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 our Home Assistant add-ons repository to your Home Assistant instance.
  2. Install the "Transmission NA" add-on.
  3. Change the configuration files with the required values.
  4. Start the "Transmission NA" add-on
  5. Check the logs of the "Transmission NA" add-on to see if everything went well.
  6. Click "OPEN WEB UI" to open the Transmission NA web interface.

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Transmission add-on configuration:

log_level: info
authentication_required: false
username: 'your_username'
password: 'your_password'
openvpn_enabled: false
openvpn_config: ''
openvpn_username: ''
openvpn_password: ''
networkdisks:
  - //serverip/folder
cifsusername: 'your samba user'
cifspassword: 'password'

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Option: authentication_required

This option can be used to password protect the web-ui.

Option: username

The username for authentication.

Option: password

The password for authentication.

Option: openvpn_enabled

Enable OpenVPN to anonymize your torrent activity.

Option: openvpn_config

The name of .ovpn file. You should put it in /config/openvpn.

Option: openvpn_username

Your OpenVPN username.

Option: openvpn_password

Your OpenVPN password.

Option: networkdisks

PROTECTION MODE NEEDS TO BE DISABLED TO WORK

Is the list of networks share to mount at boot. The mounted driver is on /<SERVER>/<SHARE> directory.

Option: cifsusername

The username to use to mount the network shares

Option: cifspassword

The password used to mount the networks shares

Embedding into Home Assistant

This addon supports ingress, thus it can simply be integrated into Home Assistant without having to forward any additional ports. Here is an example configuration:

transmission:
  host: 1dd81675_transmission-nas

If you want, you can add an icon to the sidebar by toggling Show in Sidebar as well.

Changelog & Releases

The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

License

MIT License

Copyright (c) 2018 Pierrick Rouxel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Transmission addon for Hass.io

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 57.3%
  • Dockerfile 42.7%