diff --git a/READMETEMPLATE.md b/READMETEMPLATE.md index fb19a71..265fd26 100644 --- a/READMETEMPLATE.md +++ b/READMETEMPLATE.md @@ -2,25 +2,27 @@ The [LinuxServer.io](https://www.linuxserver.io/) team brings you another quality container release featuring auto-update on startup, 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`. -# linuxserver/ +# 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= -v /etc/localtime:/etc/localtime:ro -v :/config -e PGID= -e PUID= -p 1234:1234 linuxserver/ +docker create --name=transmission -v /etc/localtime:/etc/localtime:ro -v :/config -v :/downloads -e PGID= -e PUID= -p 9091:9091 -p 51413:51413 linuxserver/transmission ``` **Parameters** -* `-p 4242` - the port(s) +* `-p 9091` +* `-p 51413` - the port(s) * `-v /etc/localtime` for timesync - *optional* -* `-v /config` - +* `-v /config` - where transmission should store config files and logs +* `-v /downloads` - local path for downloads * `-e PGID` for GroupID - see below for explanation * `-e PUID` for UserID - see below for explanation -It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it /bin/bash`. +It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`. ### User / Group Identifiers @@ -30,17 +32,17 @@ Part of what makes our containers work so well is by allowing you to specify you ## Setting up the application - DELETE ME +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. ## Updates -* Upgrade to the latest version simply `docker restart `. -* To monitor the logs of the container in realtime `docker logs -f `. +* Upgrade to the latest version simply `docker restart transmission`. +* To monitor the logs of the container in realtime `docker logs -f transmission`. ## Versions -+ **dd.MM.yyyy:** This is the standard Version type now. ++ **dd.MM.yyyy:** Initial Release.