Files
docker-transmission/README.md

57 lines
2.7 KiB
Markdown
Raw Normal View History

2016-01-08 20:43:04 +00:00
![https://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
2015-11-13 08:06:39 +00:00
2016-07-01 09:46:34 +01:00
The [LinuxServer.io](https://www.linuxserver.io/) team brings you another quality container release featuring easy user mapping and community support. Be sure to checkout our [forums](https://forum.linuxserver.io/index.php) or for real-time support our [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`.
2015-11-13 08:06:39 +00:00
2015-11-16 21:39:45 +00:00
# linuxserver/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/)
## Usage
```
docker create --name=transmission \
-v /etc/localtime:/etc/localtime:ro \
-v <path to data>:/config \
-v <path to downloads>:/downloads \
-v <path to watch folder>:/watch \
-e PGID=<gid> -e PUID=<uid> \
-p 9091:9091 -p 51413:51413 -p 51413:51413/udp \
linuxserver/transmission
2015-11-16 21:39:45 +00:00
```
**Parameters**
* `-p 9091`
* `-p 51413` - the port(s)
* `-v /etc/localtime` for timesync - *optional*
* `-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
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
2016-07-01 09:46:34 +01:00
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`.
2015-11-16 21:39:45 +00:00
### User / Group Identifiers
**TL;DR** - The `PGID` and `PUID` values set the user / group you'd like your container to 'run as' to the host OS. This can be a user you've created or even root (not recommended).
Part of what makes our containers work so well is by allowing you to specify your own `PUID` and `PGID`. This avoids nasty permissions errors with relation to data volumes (`-v` flags). When an application is installed on the host OS it is normally added to the common group called users, Docker apps due to the nature of the technology can't be added to this group. So we added this feature to let you easily choose when running your containers.
## Setting up the application
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.
2016-07-01 09:46:34 +01:00
## Info
2015-11-16 21:39:45 +00:00
* To monitor the logs of the container in realtime `docker logs -f transmission`.
## Versions
2016-07-01 09:46:34 +01:00
+ **01.07.16:** Rebase to alpine for smaller image size.
+ **06.12.15:** Separate mapping for watch folder.
+ **16.11.15:** Initial Release.
2015-11-13 08:06:39 +00:00