docker-documentation/images/docker-transmission.md

linuxserver/transmission

Transmission is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling ghcr.io/linuxserver/transmission should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Tag
x86-64	amd64-latest
arm64	arm64v8-latest
armhf	arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

docker-compose (recommended)

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  transmission:
    image: ghcr.io/linuxserver/transmission
    container_name: transmission
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - TRANSMISSION_WEB_HOME=/combustion-release/ #optional
      - USER=username #optional
      - PASS=password #optional
      - WHITELIST=iplist #optional
    volumes:
      - <path to data>:/config
      - <path to downloads>:/downloads
      - <path to watch folder>:/watch
    ports:
      - 9091:9091
      - 51413:51413
      - 51413:51413/udp
    restart: unless-stopped

docker cli

docker run -d \
  --name=transmission \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e TRANSMISSION_WEB_HOME=/combustion-release/ `#optional` \
  -e USER=username `#optional` \
  -e PASS=password `#optional` \
  -e WHITELIST=iplist `#optional` \
  -p 9091:9091 \
  -p 51413:51413 \
  -p 51413:51413/udp \
  -v <path to data>:/config \
  -v <path to downloads>:/downloads \
  -v <path to watch folder>:/watch \
  --restart unless-stopped \
  ghcr.io/linuxserver/transmission

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter	Function
9091	WebUI
51413	Torrent Port TCP
51413/udp	Torrent Port UDP

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
TZ=Europe/London	Specify a timezone to use EG Europe/London.
TRANSMISSION_WEB_HOME=/combustion-release/	Specify an alternative UI options are /combustion-release/, /transmission-web-control/, and /kettu/ .
USER=username	Specify an optional username for the interface
PASS=password	Specify an optional password for the interface
WHITELIST=iplist	Specify an optional list of comma separated host whitelist

Volume Mappings (-v)

Volume	Function
/config	Where transmission should store config files and logs.
/downloads	Local path for downloads.
/watch	Watch folder for torrent files.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

Webui is on port 9091, the settings.json file in /config has extra settings not available in the webui. Stop the container before editing it or any changes won't be saved.

If you choose to use transmission-web-control as your default UI, just note that the origional Web UI will not be available to you despite the button being present.

Securing the webui with a username/password.

Use the USER and PASS variables in docker run/create/compose to set authentication. Do not manually edit the settings.json to input user/pass, otherwise transmission cannot be stopped cleanly by the s6 supervisor.

Updating Blocklists Automatically

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.

The automatic update will run once a day at 3am local server time.

Using whitelist

Use WHITELIST to enable an ip of whitelist. Both notation rpc-whitelist and rpc-host-whitelist are supported. When WHITELIST is empty the whitelist is disabled.

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:
  • docker exec -it transmission /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f transmission
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/transmission

Versions

• 23.01.21: - Rebasing to alpine 3.13.
• 02.11.20: - Add ca-certificates package to allow connecting to https trackers.
• 02.06.20: - Rebase to alpine 3.12, update to transmission 3.0, remove python2, add python3.
• 11.05.20: - Remove unnecessary chmod (remnant of previous change).
• 28.04.20: - Use transmission-remote to update blocklist.
• 30.03.20: - Internalize blocklist-update.sh.
• 29.03.20: - Update auth info in readme.
• 19.12.19: - Rebasing to alpine 3.11.
• 04.10.19: - Update package label.
• 21.08.19: - Add optional user/pass environment variables, fix transmission shut down if user/pass are set.
• 19.07.19: - Send SIGTERM in blocklist update to properly close pid.
• 28.06.19: - Rebasing to alpine 3.10.
• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
• 22.02.19: - Rebase to Alpine 3.9, add themes to baseimage, add python and findutils.
• 22.02.19: - Catch term and clean exit.
• 07.02.19: - Add pipeline logic and multi arch.
• 15.08.18: - Rebase to alpine linux 3.8.
• 12.02.18: - Pull transmission from edge repo.
• 10.01.18: - Rebase to alpine linux 3.7.
• 25.07.17: - Add rsync package.
• 27.05.17: - Rebase to alpine linux 3.6.
• 06.02.17: - Rebase to alpine linux 3.5.
• 15.01.17: - Add p7zip, tar , unrar and unzip packages.
• 16.10.16: - Blocklist autoupdate with optional authentication.
• 14.10.16: - Add version layer informationE.
• 23.09.16: - Add information about securing the webui to README.
• 21.09.16: - Add curl package.
• 09.09.16: - Add layer badges to README.
• 28.08.16: - Add badges to README.
• 09.08.16: - Rebase to alpine linux.
• 06.12.15: - Separate mapping for watch folder.
• 16.11.15: - Initial Release.