Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-12 09:37:11 -05:00
rodzic ca4824a114
commit 3f123fbb85
1 zmienionych plików z 124 dodań i 69 usunięć

Wyświetl plik

@ -1,72 +1,127 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/transmission](https://github.com/linuxserver/docker-transmission)
[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/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/transmission.svg)](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/transmission.svg)](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)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/transmission.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-transmission/master)](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)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [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.
* [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!
# linuxserver/transmission ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/transmission.svg)](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/transmission.svg)](https://microbadger.com/images/linuxserver/transmission "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/transmission.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/transmission.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-transmission)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-transmission/)
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/) 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 |
[![transmission](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/transmission.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create --name=transmission \ docker create \
-v <path to data>:/config \ --name=transmission \
-v <path to downloads>:/downloads \ -e PUID=1001 \
-v <path to watch folder>:/watch \ -e PGID=1001 \
-e PGID=<gid> -e PUID=<uid> \ -e TZ=Europe/London \
-e TZ=<timezone> \ -p 9091:9091 \
-p 9091:9091 -p 51413:51413 \ -p 51413:51413 \
-p 51413:51413/udp \ -p 51413:51413/udp \
linuxserver/transmission -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.
```yaml
---
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 ## 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. 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.
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 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `9091` | WebUI |
| `51413` | Torrent Port TCP |
| `51413/udp` | Torrent Port UDP |
* `-p 9091` ### Environment Variables (`-e`)
* `-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
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`. | Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### User / Group Identifiers ### Volume Mappings (`-v`)
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" ™. | Volume | Function |
| :----: | --- |
| `/config` | Where transmission should store config files and logs. |
| `/downloads` | Local path for downloads. |
| `/watch` | Watch folder for torrent files. |
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
## 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=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) 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. 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. ## Securing the webui with a username/password.
this requires 3 settings to be changed in the settings.json file. this requires 3 settings to be changed in the settings.json file.
@ -89,35 +144,35 @@ 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. 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`.
* container version number ## Support Info
`docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission`
* image version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/transmission`
* 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" }}' linuxserver/transmission`
## Versions ## Versions
+ **07.02.19:** Add pipeline logic and multi arch. * **07.02.19:** - Add pipeline logic and multi arch.
+ **15.08.18:** Rebase to alpine linux 3.8. * **15.08.18:** - Rebase to alpine linux 3.8.
+ **12.02.18:** Pull transmission from edge repo. * **12.02.18:** - Pull transmission from edge repo.
+ **10.01.18:** Rebase to alpine linux 3.7. * **10.01.18:** - Rebase to alpine linux 3.7.
+ **25.07.17:** Add rsync package. * **25.07.17:** - Add rsync package.
+ **27.05.17:** Rebase to alpine linux 3.6. * **27.05.17:** - Rebase to alpine linux 3.6.
+ **06.02.17:** Rebase to alpine linux 3.5. * **06.02.17:** - Rebase to alpine linux 3.5.
+ **15.01.17:** Add p7zip, tar , unrar and unzip packages. * **15.01.17:** - Add p7zip, tar , unrar and unzip packages.
+ **16.10.16:** Blocklist autoupdate with optional authentication. * **16.10.16:** - Blocklist autoupdate with optional authentication.
+ **14.10.16:** Add version layer information. * **14.10.16:** - Add version layer informationE.
+ **23.09.16:** Add information about securing the webui to README.. * **23.09.16:** - Add information about securing the webui to README.
+ **21.09.16:** Add curl package. * **21.09.16:** - Add curl package.
+ **09.09.16:** Add layer badges to README. * **09.09.16:** - Add layer badges to README.
+ **28.08.16:** Add badges to README. * **28.08.16:** - Add badges to README.
+ **09.08.16:** Rebase to alpine linux. * **09.08.16:** - Rebase to alpine linux.
+ **06.12.15:** Separate mapping for watch folder. * **06.12.15:** - Separate mapping for watch folder.
+ **16.11.15:** Initial Release. * **16.11.15:** - Initial Release.