docker-documentation/images/docker-transmission.md

203 wiersze
9.9 KiB
Markdown
Czysty Zwykły widok Historia

2020-04-28 19:15:08 +00:00
# [linuxserver/transmission](https://github.com/linuxserver/docker-transmission)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-transmission.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-transmission)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-transmission.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-transmission/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-transmission/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-transmission/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/transmission)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/transmission.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/transmission)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/transmission.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/transmission)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-transmission/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-transmission/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/transmission/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/transmission/latest/index.html)
2019-02-11 18:25:59 +00:00
2019-02-12 14:37:11 +00: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.
2019-02-11 18:25:59 +00:00
2019-02-12 14:37:11 +00:00
## Supported Architectures
2019-02-11 18:25:59 +00:00
2019-09-04 18:21:58 +00: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-12 14:37:11 +00:00
Simply pulling `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 |
2020-04-28 19:15:08 +00:00
| :----: | --- |
2019-02-12 14:37:11 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-27 19:21:41 +00:00
| armhf | arm32v7-latest |
2019-02-11 18:25:59 +00:00
2020-04-28 19:15:08 +00:00
2019-02-11 18:25:59 +00:00
## Usage
2019-02-12 14:37:11 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-04-28 19:15:08 +00:00
```
2019-02-12 14:37:11 +00:00
docker create \
--name=transmission \
2019-03-06 19:21:41 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:37:11 +00:00
-e TZ=Europe/London \
2019-02-25 21:42:19 +00:00
-e TRANSMISSION_WEB_HOME=/combustion-release/ `#optional` \
2019-08-21 23:45:52 +00:00
-e USER=username `#optional` \
-e PASS=password `#optional` \
2019-02-12 14:37:11 +00:00
-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 \
linuxserver/transmission
```
2020-04-28 19:15:08 +00:00
2019-02-12 14:37:11 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-08 18:22:20 +00:00
version: "2.1"
2019-02-12 14:37:11 +00:00
services:
transmission:
image: linuxserver/transmission
container_name: transmission
environment:
2019-03-06 19:21:41 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:37:11 +00:00
- TZ=Europe/London
2019-02-25 21:42:19 +00:00
- TRANSMISSION_WEB_HOME=/combustion-release/ #optional
2019-08-21 23:45:52 +00:00
- USER=username #optional
- PASS=password #optional
2019-02-12 14:37:11 +00: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
2019-02-11 18:25:59 +00:00
```
## Parameters
2020-04-28 19:15:08 +00:00
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.
2019-02-12 14:37:11 +00:00
2020-04-28 19:15:08 +00:00
### Ports (`-p`)
2019-02-12 14:37:11 +00:00
| Parameter | Function |
2020-04-28 19:15:08 +00:00
| :----: | --- |
2019-02-12 14:37:11 +00:00
| `9091` | WebUI |
| `51413` | Torrent Port TCP |
| `51413/udp` | Torrent Port UDP |
2019-02-11 18:25:59 +00:00
2020-04-28 19:15:08 +00:00
### Environment Variables (`-e`)
2019-02-11 18:25:59 +00:00
2019-02-12 14:37:11 +00:00
| Env | Function |
2020-04-28 19:15:08 +00:00
| :----: | --- |
2019-03-06 19:21:41 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:37:11 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-06-17 15:58:10 +00:00
| `TRANSMISSION_WEB_HOME=/combustion-release/` | Specify an alternative UI options are `/combustion-release/`, `/transmission-web-control/`, and `/kettu/` . |
2019-08-21 23:45:52 +00:00
| `USER=username` | Specify an optional username for the interface |
| `PASS=password` | Specify an optional password for the interface |
2019-02-11 18:25:59 +00:00
2020-04-28 19:15:08 +00:00
### Volume Mappings (`-v`)
2019-02-11 18:25:59 +00:00
2019-02-12 14:37:11 +00:00
| Volume | Function |
2020-04-28 19:15:08 +00:00
| :----: | --- |
2019-02-12 14:37:11 +00:00
| `/config` | Where transmission should store config files and logs. |
| `/downloads` | Local path for downloads. |
| `/watch` | Watch folder for torrent files. |
2019-02-11 18:25:59 +00:00
2020-04-28 19:15:08 +00:00
2019-02-12 14:37:11 +00:00
## User / Group Identifiers
2020-04-28 19:15:08 +00: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`.
2019-02-12 14:37:11 +00: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:41 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-11 18:25:59 +00:00
2020-04-28 19:15:08 +00:00
```
2019-02-12 14:37:11 +00:00
$ id username
2019-03-06 19:21:41 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-11 18:25:59 +00:00
```
2019-02-12 14:37:11 +00:00
## Application Setup
2019-02-11 18:25:59 +00: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.
2019-02-25 21:42:19 +00:00
2020-04-28 19:15:08 +00:00
For users pulling an update and unable to access the webui setting you may need to set "rpc-host-whitelist-enabled": false, in /config/settings.json`
2019-02-25 21:42:19 +00:00
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.
2019-02-11 18:25:59 +00:00
## Securing the webui with a username/password.
2020-03-30 05:02:45 +00:00
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.
2019-02-11 18:25:59 +00: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.
The automatic update will run once a day at 3am local server time.
2020-04-28 19:15:08 +00:00
2020-04-08 18:22:20 +00:00
## Docker Mods
2020-04-28 19:15:08 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&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.")
2020-04-08 18:22:20 +00:00
2020-04-28 19:15:08 +00: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) can be accessed via the dynamic badge above.
2020-04-08 18:22:20 +00:00
2019-10-02 18:22:03 +00:00
2019-02-12 14:37:11 +00:00
## Support Info
2019-02-11 18:25:59 +00:00
2019-09-04 18:21:58 +00:00
* Shell access whilst the container is running:
2019-02-12 14:37:11 +00:00
* `docker exec -it transmission /bin/bash`
2019-09-04 18:21:58 +00:00
* To monitor the logs of the container in realtime:
2019-02-12 14:37:11 +00:00
* `docker logs -f transmission`
2019-09-04 18:21:58 +00:00
* Container version number
2019-02-12 14:37:11 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/transmission`
2019-02-11 18:25:59 +00:00
## Versions
2020-05-11 17:29:19 +00:00
* **11.05.20:** - Remove unnecessary chmod (remnant of previous change).
2020-04-28 19:15:08 +00:00
* **28.04.20:** - Use transmission-remote to update blocklist.
2020-03-30 19:08:41 +00:00
* **30.03.20:** - Internalize blocklist-update.sh.
2020-03-30 05:02:45 +00:00
* **29.03.20:** - Update auth info in readme.
2020-01-02 16:17:16 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-10-07 08:11:36 +00:00
* **04.10.19:** - Update package label.
2019-08-21 23:45:52 +00:00
* **21.08.19:** - Add optional user/pass environment variables, fix transmission shut down if user/pass are set.
2019-07-20 05:11:26 +00:00
* **19.07.19:** - Send SIGTERM in blocklist update to properly close pid.
2019-07-05 18:38:43 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-27 19:21:41 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-25 21:42:19 +00:00
* **22.02.19:** - Rebase to Alpine 3.9, add themes to baseimage, add python and findutils.
2019-02-23 08:13:16 +00:00
* **22.02.19:** - Catch term and clean exit.
2019-02-12 14:37:11 +00:00
* **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.