The LinuxServer.io team brings you another container release featuring:
Find us at:
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.
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/transmission:latest
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 | Available | Tag |
---|---|---|
x86-64 | ✅ | amd64-\<version tag> |
arm64 | ✅ | arm64v8-\<version tag> |
armhf | ❌ |
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.
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.
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.
Use WHITELIST
to enable a list of ip as whitelist. This enable support for rpc-whitelist
. When WHITELIST
is empty support for whitelist is disabled.
Use HOST_WHITELIST
to enable an list of dns names as host-whitelist. This enable support for rpc-host-whitelist
. When HOST_WHITELIST
is empty support for host-whitelist is disabled.
Use PEERPORT
to specify the port(s) Transmission should listen on. This disables random port selection. This should be the same as the port mapped in your docker configuration.
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
services:
transmission:
image: lscr.io/linuxserver/transmission:latest
container_name: transmission
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- TRANSMISSION_WEB_HOME= #optional
- USER= #optional
- PASS= #optional
- WHITELIST= #optional
- PEERPORT= #optional
- HOST_WHITELIST= #optional
volumes:
- /path/to/transmission/data:/config
- /path/to/downloads:/downloads
- /path/to/watch/folder:/watch
ports:
- 9091:9091
- 51413:51413
- 51413:51413/udp
restart: unless-stopped
docker run -d \
--name=transmission \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e TRANSMISSION_WEB_HOME= `#optional` \
-e USER= `#optional` \
-e PASS= `#optional` \
-e WHITELIST= `#optional` \
-e PEERPORT= `#optional` \
-e HOST_WHITELIST= `#optional` \
-p 9091:9091 \
-p 51413:51413 \
-p 51413:51413/udp \
-v /path/to/transmission/data:/config \
-v /path/to/downloads:/downloads \
-v /path/to/watch/folder:/watch \
--restart unless-stopped \
lscr.io/linuxserver/transmission:latest
Containers 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.
Parameter | Function |
---|---|
-p 9091 |
WebUI |
-p 51413 |
Torrent Port TCP |
-p 51413/udp |
Torrent Port UDP |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Etc/UTC |
specify a timezone to use, see this list. |
-e TRANSMISSION_WEB_HOME= |
Specify the path to an alternative UI folder. |
-e USER= |
Specify an optional username for the interface |
-e PASS= |
Specify an optional password for the interface |
-e WHITELIST= |
Specify an optional list of comma separated ip whitelist. Fills rpc-whitelist setting. |
-e PEERPORT= |
Specify an optional port for torrent TCP/UDP connections. Fills peer-port setting. |
-e HOST_WHITELIST= |
Specify an optional list of comma separated dns name whitelist. Fills rpc-host-whitelist setting. |
-v /config |
Where transmission should store config files and logs. |
-v /downloads |
Local path for downloads. |
-v /watch |
Watch folder for torrent files. |
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
Will set the environment variable MYVAR
based on the contents of the /run/secrets/mysecretvariable
file.
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.
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 your_user
as below:
id your_user
Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
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.
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" }}' lscr.io/linuxserver/transmission:latest
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Update images:
All images:
docker-compose pull
Single image:
docker-compose pull transmission
Update containers:
All containers:
docker-compose up -d
Single container:
docker-compose up -d transmission
You can also remove the old dangling images:
docker image prune
Update the image:
docker pull lscr.io/linuxserver/transmission:latest
Stop the running container:
docker stop transmission
Delete the container:
docker rm transmission
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config
folder and settings will be preserved)
You can also remove the old dangling images:
docker image prune
tip: We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-transmission.git
cd docker-transmission
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/transmission:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.