mirror of
https://github.com/linuxserver/docker-transmission.git
synced 2025-11-01 09:25:48 +01:00
update to new readme format
This commit is contained in:
thelamer
215
README.md
215
README.md
@@ -1,72 +1,137 @@
|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://www.transmissionbt.com/
|
||||
[hub]: https://hub.docker.com/r/linuxserver/transmission/
|
||||
[](https://linuxserver.io)
|
||||
|
||||
[][linuxserverurl]
|
||||
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
|
||||
|
||||
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
||||
* [forum.linuxserver.io][forumurl]
|
||||
* [IRC][ircurl] on freenode at `#linuxserver.io`
|
||||
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
||||
* 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
|
||||
|
||||
# linuxserver/transmission
|
||||
[](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/transmission "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-transmission/)
|
||||
Find us at:
|
||||
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
|
||||
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
|
||||
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
||||
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
|
||||
|
||||
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. [Transmission](http://www.transmissionbt.com/about/)
|
||||
# PSA: Changes are happening
|
||||
|
||||
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
|
||||
|
||||
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
|
||||
|
||||
# [linuxserver/transmission](https://github.com/linuxserver/docker-transmission)
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-transmission/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/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.
|
||||
|
||||
[](https://www.transmissionbt.com/)
|
||||
|
||||
## 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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
|
||||
|
||||
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 |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
docker create --name=transmission \
|
||||
-v <path to data>:/config \
|
||||
-v <path to downloads>:/downloads \
|
||||
-v <path to watch folder>:/watch \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e TZ=<timezone> \
|
||||
-p 9091:9091 -p 51413:51413 \
|
||||
-p 51413:51413/udp \
|
||||
linuxserver/transmission
|
||||
docker create \
|
||||
--name=transmission \
|
||||
-e PUID=1001 \
|
||||
-e PGID=1001 \
|
||||
-e TZ=Europe/London \
|
||||
-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
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
transmission:
|
||||
image: linuxserver/transmission
|
||||
container_name: transmission
|
||||
environment:
|
||||
- PUID=1001
|
||||
- PGID=1001
|
||||
- TZ=Europe/London
|
||||
volumes:
|
||||
- <path to data>:/config
|
||||
- <path to downloads>:/downloads
|
||||
- <path to watch folder>:/watch
|
||||
ports:
|
||||
- 9091:9091
|
||||
- 51413:51413
|
||||
- 51413:51413/udp
|
||||
mem_limit: 4096m
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
||||
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
|
||||
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
|
||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
|
||||
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.
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| `-p 9091` | WebUI |
|
||||
| `-p 51413` | Torrent Port TCP |
|
||||
| `-p 51413/udp` | Torrent Port UDP |
|
||||
| `-e PUID=1001` | for UserID - see below for explanation |
|
||||
| `-e PGID=1001` | for GroupID - see below for explanation |
|
||||
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `-v /config` | Where transmission should store config files and logs. |
|
||||
| `-v /downloads` | Local path for downloads. |
|
||||
| `-v /watch` | Watch folder for torrent files. |
|
||||
|
||||
* `-p 9091`
|
||||
* `-p 51413` - the port(s)
|
||||
* `-v /config` - where transmission should store config files and logs
|
||||
* `-v /downloads` - local path for downloads
|
||||
* `-v /watch` - watch folder for torrent files
|
||||
* `-e PGID` for GroupID - see below for explanation
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
* `-e TZ` for timezone information, eg Europe/London
|
||||
## User / Group Identifiers
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`.
|
||||
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`.
|
||||
|
||||
### User / Group Identifiers
|
||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||
|
||||
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
|
||||
|
||||
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
$ id username
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
this requires 3 settings to be changed in the settings.json file.
|
||||
@@ -89,33 +154,53 @@ The automatic update is a shell script that downloads a blocklist from the url s
|
||||
|
||||
The automatic update will run once a day at 3am local server time.
|
||||
|
||||
## Info
|
||||
|
||||
* To monitor the logs of the container in realtime `docker logs -f transmission`.
|
||||
|
||||
## 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`
|
||||
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission`
|
||||
* image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/transmission`
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/transmission`
|
||||
## Updating Info
|
||||
|
||||
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:
|
||||
|
||||
### Via Docker Run/Create
|
||||
* Update the image: `docker pull linuxserver/transmission`
|
||||
* Stop the running container: `docker stop transmission`
|
||||
* Delete the container: `docker rm transmission`
|
||||
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
||||
* Start the new container: `docker start transmission`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
### Via Docker Compose
|
||||
* Update the image: `docker-compose pull linuxserver/transmission`
|
||||
* Let compose update containers as necessary: `docker-compose up -d`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
## Versions
|
||||
|
||||
+ **24.11.17:** Clean stop transmission when there are active torrents, fix cron start
|
||||
+ **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 information.
|
||||
+ **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.
|
||||
|
||||
* **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.
|
||||
|
||||
94
readme-vars.yml
Normal file
94
readme-vars.yml
Normal file
@@ -0,0 +1,94 @@
|
||||
---
|
||||
|
||||
# project information
|
||||
project_name: transmission
|
||||
project_url: "https://www.transmissionbt.com/"
|
||||
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/transmission.png"
|
||||
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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."
|
||||
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
|
||||
project_blurb_optional_extras_enabled: false
|
||||
|
||||
# supported architectures
|
||||
available_architectures:
|
||||
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
|
||||
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
||||
- { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"}
|
||||
|
||||
# development version
|
||||
development_versions: false
|
||||
|
||||
# container parameters
|
||||
common_param_env_vars_enabled: true
|
||||
param_container_name: "{{ project_name }}"
|
||||
param_usage_include_net: false
|
||||
param_usage_include_env: true
|
||||
param_env_vars:
|
||||
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
|
||||
param_usage_include_vols: true
|
||||
param_volumes:
|
||||
- { vol_path: "/config", vol_host_path: "<path to data>", desc: "Where transmission should store config files and logs." }
|
||||
- { vol_path: "/downloads", vol_host_path: "<path to downloads>", desc: "Local path for downloads." }
|
||||
- { vol_path: "/watch", vol_host_path: "<path to watch folder>", desc: "Watch folder for torrent files." }
|
||||
param_usage_include_ports: true
|
||||
param_ports:
|
||||
- { external_port: "9091", internal_port: "9091", port_desc: "WebUI" }
|
||||
- { external_port: "51413", internal_port: "51413", port_desc: "Torrent Port TCP" }
|
||||
- { external_port: "51413", internal_port: "51413/udp", port_desc: "Torrent Port UDP" }
|
||||
param_device_map: false
|
||||
cap_add_param: false
|
||||
|
||||
# optional container parameters
|
||||
opt_param_usage_include_env: false
|
||||
opt_param_usage_include_vols: false
|
||||
opt_param_usage_include_ports: false
|
||||
opt_param_device_map: false
|
||||
opt_cap_add_param: false
|
||||
optional_block_1: false
|
||||
|
||||
# application setup block
|
||||
app_setup_block_enabled: true
|
||||
app_setup_block: |
|
||||
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.
|
||||
|
||||
this requires 3 settings to be changed in the settings.json file.
|
||||
|
||||
`Make sure the container is stopped before editing these settings.`
|
||||
|
||||
`"rpc-authentication-required": true,` - check this, the default is false, change to true.
|
||||
|
||||
`"rpc-username": "transmission",` substitute transmission for your chosen user name, this is just an example.
|
||||
|
||||
`rpc-password` will be a hash starting with {, replace everything including the { with your chosen password, keeping the quotes.
|
||||
|
||||
Transmission will convert it to a hash when you restart the container after making the above edits.
|
||||
|
||||
## 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.
|
||||
|
||||
# changelog
|
||||
changelogs:
|
||||
- { date: "22.02.19:", desc: "Catch term and clean exit." }
|
||||
- { date: "07.02.19:", desc: "Add pipeline logic and multi arch." }
|
||||
- { date: "15.08.18:", desc: "Rebase to alpine linux 3.8." }
|
||||
- { date: "12.02.18:", desc: "Pull transmission from edge repo." }
|
||||
- { date: "10.01.18:", desc: "Rebase to alpine linux 3.7." }
|
||||
- { date: "25.07.17:", desc: "Add rsync package." }
|
||||
- { date: "27.05.17:", desc: "Rebase to alpine linux 3.6." }
|
||||
- { date: "06.02.17:", desc: "Rebase to alpine linux 3.5." }
|
||||
- { date: "15.01.17:", desc: "Add p7zip, tar , unrar and unzip packages." }
|
||||
- { date: "16.10.16:", desc: "Blocklist autoupdate with optional authentication." }
|
||||
- { date: "14.10.16:", desc: "Add version layer informationE." }
|
||||
- { date: "23.09.16:", desc: "Add information about securing the webui to README." }
|
||||
- { date: "21.09.16:", desc: "Add curl package." }
|
||||
- { date: "09.09.16:", desc: "Add layer badges to README." }
|
||||
- { date: "28.08.16:", desc: "Add badges to README." }
|
||||
- { date: "09.08.16:", desc: "Rebase to alpine linux." }
|
||||
- { date: "06.12.15:", desc: "Separate mapping for watch folder." }
|
||||
- { date: "16.11.15:", desc: "Initial Release." }
|
||||
|
||||
Reference in New Issue
Block a user