Files
docker-transmission/README.md

291 lines
17 KiB
Markdown
Raw Normal View History

2020-10-04 10:04:02 -04:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the CONTRIBUTING.md -->
2019-02-23 00:00:49 -08:00
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
2015-11-13 08:06:39 +00:00
2020-06-03 00:53:25 +02:00
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
[![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
2019-09-04 19:21:53 +01:00
2020-04-08 18:22:16 +00:00
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
2016-09-09 21:55:25 +01:00
2019-02-23 00:00:49 -08:00
* regular and timely application updates
* easy user mappings (PGID, PUID)
* custom base image with s6 overlay
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates
2015-11-13 08:06:39 +00:00
2019-02-23 00:00:49 -08:00
Find us at:
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2019-09-04 19:21:53 +01:00
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
2019-10-30 15:21:52 -04:00
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
2019-09-04 19:21:53 +01:00
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
2015-11-16 21:39:45 +00:00
2019-02-23 00:00:49 -08:00
# [linuxserver/transmission](https://github.com/linuxserver/docker-transmission)
2019-10-30 15:21:52 -04:00
2020-06-03 00:53:25 +02:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-transmission.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-transmission)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-transmission.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-transmission/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-transmission/packages)
2020-12-16 22:32:20 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-transmission/container_registry)
2020-06-03 00:53:25 +02:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/transmission.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/transmission.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/transmission)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/transmission.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/transmission)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-transmission%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-transmission/job/master/)
2020-11-02 15:34:40 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Ftransmission%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/transmission/latest/index.html)
2019-02-23 00:00:49 -08:00
[Transmission](https://www.transmissionbt.com/) 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.
[![transmission](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/transmission.png)](https://www.transmissionbt.com/)
## Supported Architectures
2019-09-04 19:21:53 +01:00
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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-23 00:00:49 -08:00
2020-11-02 15:34:40 +00:00
Simply pulling `ghcr.io/linuxserver/transmission` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-23 00:00:49 -08:00
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
2015-11-16 21:39:45 +00:00
2016-08-28 01:29:02 +01:00
2015-11-16 21:39:45 +00:00
## Usage
2019-02-23 00:00:49 -08:00
Here are some example snippets to help you get started creating a container.
2020-10-04 10:04:02 -04:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2016-10-17 23:54:40 +01:00
2019-02-23 00:00:49 -08:00
Compatible with docker-compose v2 schemas.
2015-11-16 21:39:45 +00:00
2020-10-04 10:04:02 -04:00
```yaml
2019-02-23 00:00:49 -08:00
---
2020-04-08 18:22:16 +00:00
version: "2.1"
2019-02-23 00:00:49 -08:00
services:
transmission:
2020-11-02 15:34:40 +00:00
image: ghcr.io/linuxserver/transmission
2019-02-23 00:00:49 -08:00
container_name: transmission
environment:
2019-03-06 19:21:36 +00:00
- PUID=1000
- PGID=1000
2019-02-23 00:00:49 -08:00
- TZ=Europe/London
- TRANSMISSION_WEB_HOME=/combustion-release/ #optional
2019-08-21 18:14:28 -04:00
- USER=username #optional
- PASS=password #optional
2019-02-23 00:00:49 -08:00
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
```
2020-10-04 10:04:02 -04:00
### 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` \
-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 \
2020-11-02 15:34:40 +00:00
ghcr.io/linuxserver/transmission
2020-10-04 10:04:02 -04:00
```
2019-02-23 00:00:49 -08:00
## Parameters
Container 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.
2015-11-16 21:39:45 +00:00
2019-02-23 00:00:49 -08:00
| Parameter | Function |
| :----: | --- |
| `-p 9091` | WebUI |
| `-p 51413` | Torrent Port TCP |
| `-p 51413/udp` | Torrent Port UDP |
2019-03-06 19:21:36 +00:00
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
2019-02-23 00:00:49 -08:00
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-06-17 08:49:12 -07:00
| `-e TRANSMISSION_WEB_HOME=/combustion-release/` | Specify an alternative UI options are `/combustion-release/`, `/transmission-web-control/`, and `/kettu/` . |
2019-08-21 18:14:28 -04:00
| `-e USER=username` | Specify an optional username for the interface |
| `-e PASS=password` | Specify an optional password for the interface |
| `-e WHITELIST=iplist` | Specify an optional list of comma separated host whitelist |
2019-02-23 00:00:49 -08:00
| `-v /config` | Where transmission should store config files and logs. |
| `-v /downloads` | Local path for downloads. |
| `-v /watch` | Watch folder for torrent files. |
2015-11-16 21:39:45 +00:00
2019-12-04 19:22:19 +00:00
## Environment variables from files (Docker secrets)
2020-06-03 00:53:25 +02:00
You can set any environment variable from a file by using a special prepend `FILE__`.
2019-12-04 19:22:19 +00:00
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.
2020-06-03 00:53:25 +02:00
## 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](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-02-23 00:00:49 -08:00
## User / Group Identifiers
2015-11-16 21:39:45 +00:00
2019-02-23 00:00:49 -08:00
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`.
2015-11-16 21:39:45 +00:00
2019-02-23 00:00:49 -08:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-06 19:21:36 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```
2019-02-23 00:00:49 -08:00
$ id username
2019-03-06 19:21:36 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
2015-11-16 21:39:45 +00:00
2019-02-23 00:00:49 -08:00
&nbsp;
## Application Setup
2015-11-16 21:39:45 +00:00
2019-02-23 00:00:49 -08:00
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.
2017-01-16 13:00:59 +00:00
## 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.
2016-10-18 08:41:49 -04:00
## 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.
2016-10-18 08:41:49 -04:00
The automatic update will run once a day at 3am local server time.
2015-11-16 21:39:45 +00:00
## 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.
2015-11-16 21:39:45 +00:00
2020-04-08 18:22:16 +00:00
## Docker Mods
2020-10-04 10:04:02 -04:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=transmission&query=%24.mods%5B%27transmission%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=transmission "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-08 18:22:16 +00:00
2020-10-04 10:04:02 -04:00
We publish various [Docker Mods](https://github.com/linuxserver/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.
2020-04-08 18:22:16 +00:00
2015-11-16 21:39:45 +00:00
2019-02-23 00:00:49 -08:00
## Support Info
2016-10-14 15:27:26 +01:00
2019-02-23 00:00:49 -08:00
* 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`
2019-09-04 19:21:53 +01:00
* container version number
2019-02-23 00:00:49 -08:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission`
2016-10-14 15:27:26 +01:00
* image version number
2020-11-02 15:34:40 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/transmission`
2019-02-23 00:00:49 -08:00
## Updating Info
2019-09-04 19:21:53 +01:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
2019-02-23 00:00:49 -08:00
### Via Docker Compose
2019-03-06 19:21:36 +00:00
* Update all images: `docker-compose pull`
* or update a single image: `docker-compose pull transmission`
* Let compose update all containers as necessary: `docker-compose up -d`
* or update a single container: `docker-compose up -d transmission`
2019-02-23 00:00:49 -08:00
* You can also remove the old dangling images: `docker image prune`
2015-11-16 21:39:45 +00:00
2020-10-04 10:04:02 -04:00
### Via Docker Run
2020-11-02 15:34:40 +00:00
* Update the image: `docker pull ghcr.io/linuxserver/transmission`
2020-10-04 10:04:02 -04:00
* 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`
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
2019-05-05 01:30:06 +01:00
* Pull the latest image at its tag and replace it with the same env variables in one run:
```
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once transmission
```
2020-10-04 10:04:02 -04:00
* You can also remove the old dangling images: `docker image prune`
2019-07-03 19:21:52 +01:00
2020-10-04 10:04:02 -04:00
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
2019-07-03 19:21:52 +01:00
2020-10-04 10:04:02 -04:00
### Image Update Notifications - Diun (Docker Image Update Notifier)
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
2019-05-05 01:30:06 +01:00
## Building locally
2019-09-04 19:21:53 +01:00
If you want to make local modifications to these images for development purposes or just to customize the logic:
2019-05-05 01:30:06 +01:00
```
git clone https://github.com/linuxserver/docker-transmission.git
cd docker-transmission
docker build \
--no-cache \
--pull \
2020-11-02 15:34:40 +00:00
-t ghcr.io/linuxserver/transmission:latest .
2019-05-05 01:30:06 +01:00
```
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`.
2015-11-16 21:39:45 +00:00
## Versions
2016-08-28 01:29:02 +01:00
2021-01-24 23:17:27 +00:00
* **02.11.20:** - Add ca-certificates package to allow connecting to https trackers.
2020-06-06 12:01:36 -04:00
* **02.06.20:** - Rebase to alpine 3.12, update to transmission 3.0, remove python2, add python3.
2020-05-11 13:04:44 -04:00
* **11.05.20:** - Remove unnecessary chmod (remnant of previous change).
2020-04-28 15:15:05 -04:00
* **28.04.20:** - Use transmission-remote to update blocklist.
2020-03-30 10:08:06 -04:00
* **30.03.20:** - Internalize blocklist-update.sh.
* **29.03.20:** - Update auth info in readme.
2020-01-02 17:17:10 +01:00
* **19.12.19:** - Rebasing to alpine 3.11.
* **04.10.19:** - Update package label.
2019-08-21 18:14:28 -04:00
* **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.
2019-07-05 18:38:38 +00:00
* **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.
2019-02-23 00:00:49 -08:00
* **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.