kopia lustrzana https://github.com/linuxserver/docker-documentation
254 wiersze
14 KiB
Markdown
254 wiersze
14 KiB
Markdown
|
---
|
||
|
|
title: transmission
|
||
|
|
---
|
||
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||
|
|
<!-- Please read the https://github.com/linuxserver/docker-transmission/blob/master/.github/CONTRIBUTING.md -->
|
||
|
|
|
||
|
|
# [linuxserver/transmission](https://github.com/linuxserver/docker-transmission)
|
||
|
|
|
||
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Ftransmission)
|
||
|
|
[](https://github.com/linuxserver/docker-transmission)
|
||
|
|
[](https://github.com/linuxserver/docker-transmission/releases)
|
||
|
|
[](https://github.com/linuxserver/docker-transmission/packages)
|
||
|
|
[](https://gitlab.com/linuxserver.io/docker-transmission/container_registry)
|
||
|
|
[](https://quay.io/repository/linuxserver.io/transmission)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/transmission)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/transmission)
|
||
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-transmission/job/master/)
|
||
|
|
[](https://ci-tests.linuxserver.io/linuxserver/transmission/latest/index.html)
|
||
|
|
|
||
|
|
[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.
|
||
|
|
|
||
|
|
## Supported Architectures
|
||
|
|
|
||
|
|
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/).
|
||
|
|
|
||
|
|
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 | ❌ | |
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
|
||
|
|
## 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 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 alternative Transmission torrent ports
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
||
|
|
|
||
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
---
|
||
|
|
version: "2.1"
|
||
|
|
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/data:/config
|
||
|
|
- /path/to/downloads:/downloads
|
||
|
|
- /path/to/watch/folder:/watch
|
||
|
|
ports:
|
||
|
|
- 9091:9091
|
||
|
|
- 51413:51413
|
||
|
|
- 51413:51413/udp
|
||
|
|
restart: unless-stopped
|
||
|
|
```
|
||
|
|
|
||
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
||
|
|
|
||
|
|
```bash
|
||
|
|
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/data:/config \
|
||
|
|
-v /path/to/downloads:/downloads \
|
||
|
|
-v /path/to/watch/folder:/watch \
|
||
|
|
--restart unless-stopped \
|
||
|
|
lscr.io/linuxserver/transmission:latest
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
||
|
|
| `TRANSMISSION_WEB_HOME=` | Specify the path to an alternative UI folder. |
|
||
|
|
| `USER=` | Specify an optional username for the interface |
|
||
|
|
| `PASS=` | Specify an optional password for the interface |
|
||
|
|
| `WHITELIST=` | Specify an optional list of comma separated ip whitelist. Fills rpc-whitelist setting. |
|
||
|
|
| `PEERPORT=` | Specify an optional port for torrent TCP/UDP connections. Fills peer-port setting. |
|
||
|
|
| `HOST_WHITELIST=` | Specify an optional list of comma separated dns name whitelist. Fills rpc-host-whitelist setting. |
|
||
|
|
|
||
|
|
### 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. |
|
||
|
|
|
||
|
|
#### Miscellaneous Options
|
||
|
|
|
||
|
|
| Parameter | Function |
|
||
|
|
| :-----: | --- |
|
||
|
|
|
||
|
|
## Environment variables from files (Docker secrets)
|
||
|
|
|
||
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||
|
|
|
||
|
|
As an example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
-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](https://en.wikipedia.org/wiki/Umask) 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:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ id username
|
||
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Docker Mods
|
||
|
|
|
||
|
|
[](https://mods.linuxserver.io/?mod=transmission "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## 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" }}' lscr.io/linuxserver/transmission:latest`
|
||
|
|
|
||
|
|
## Versions
|
||
|
|
|
||
|
|
* **10.08.23:** - Bump unrar to 6.2.10.
|
||
|
|
* **10.06.23:** - Bump unrar to 6.2.8, install transmission-extra.
|
||
|
|
* **25.05.23:** - Deprecate armhf.
|
||
|
|
* **14.05.23:** - Explicitly install transmission-remote.
|
||
|
|
* **02.03.23:** - Add cron init to allow user customizable crontabs.
|
||
|
|
* **08.02.23:** - Rebase to Alpine Edge to get access to most up to date builds of Transmission. Remove bundled 3rd party UI packages.
|
||
|
|
* **05.01.23:** - Rebase to Alpine 3.17, restore GNU findutils package.
|
||
|
|
* **02.11.22:** - Rebase to Alpine 3.16, migrate to s6v3.
|
||
|
|
* **12.08.22:** - Bump unrar to 6.1.7.
|
||
|
|
* **03.04.22:** - Add Transmissionic as a UI option.
|
||
|
|
* **21.02.22:** - Build unrar from source, rebase to Alpine 3.15, add symlinks neeeded for TWC. Credit @alexbelgium
|
||
|
|
* **09.07.21:** - Wait for the transmission-daemon termination after a caught sigterm.
|
||
|
|
* **06.03.21:** - Add Flood for Transmission as a UI option.
|
||
|
|
* **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.
|