turgon37/transmission repository overview

⁠Docker Bittorent Transmission

This image contains an instance of Transmission client⁠. This project was inspired from this project⁠ and rewrited to provide most of the configuration with ENV variables.

:warning: Take care of the changelogs⁠ because some breaking changes may happend between versions.

⁠Features

⁠Securing the webui with a username/password.

this requires 3 settings to be changed in the settings.json file.

Make sure the container is stopped before editing these settings.

"rpc-authentication-required": true, - check this, the default is false, change to true.

"rpc-username": "transmission", substitute transmission for your chosen user name, this is just an example.

rpc-password will be a hash starting with {, replace everything including the { with your chosen password, keeping the quotes.

Transmission will convert it to a hash when you restart the container after making the above edits.

⁠Updating Blocklists Automatically

You can configure an external cron job to update automatically the blocklists. This requires "blocklist-enabled": true, to be set. By setting this to true, it is assumed you have also populated blocklist-url with a valid block list.

The automatic update is a shell script that downloads a blocklist from the url stored in the settings.json, gunzips it, and restarts the transmission daemon.

0 3 * * * root docker ps | grep --quiet 'transmission$' && docker exec --user transmission transmission /opt/transmission/blocklist-update.sh

⁠Notification by mail for done torrents

A notification script is included into this container. This script is run each times a Torrent has finished to be downloaded. By default it is able to send a mail but you can edit it to make something else. You can activate in by simply configure at least the following environment variables into your container

The following parameters are optionnal, they depends of your configuration needs

You can include any other environment variable that will be available in the mail body of the notification script (localised into /config/mail-notification.py)

⁠Docker Informations

• This port is available on this image

• This volume is bind on this image

⁠Installation

• Manual

git clone
docker build -t turgon37/transmission .

• or Automatic

docker pull turgon37/transmission

⁠Usage

docker run -p 80:9091 turgon37/transmission

⁠Docker-compose Specific configuration examples

• Simple docker-compose setting with smtp configuration

services:
  transmission:
    image: turgon37/transmission
    environment:
      - SMTP_SERVER=10.0.0.1
      - [email protected]
      - [email protected]
    ports:
      - "127.0.0.1:8001:51413:51413/tcp"
      - "127.0.0.1:8001:51413:51413/udp"
      - "127.0.0.1:8001:9091/tcp"
    volumes:
      - data-transmission:/config
      - data-transmission-download:/downloads/complete"
      - data-transmission-incomplete:/downloads/incomplete"
      - data-transmission-watch:/watch"
volumes:
  data-transmission:
  data-transmission-download:
  data-transmission-incomplete:
  data-transmission-watch: