Dockery/docker-transmission
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-transmission.git synced 2025-11-01 17:35:46 +01:00
Code Issues Packages Projects Releases Activity

first draft readme

Browse Source
This commit is contained in:
sparklyballs
2015-11-13 22:26:41 +00:00
parent 82cb89405b
commit f6c24f34cc
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
READMETEMPLATE.md
View File

@@ -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/<container-name>
# linuxserver/transmission
<Provide a short, concise description of the application. No more than two SHORT paragraphs. Link to sources where possible and include an image illustrating your point if necessary. Point users to the original applications website, as that's the best place to get support - not here.>
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=<container-name> -v /etc/localtime:/etc/localtime:ro -v <path to data>:/config -e PGID=<gid> -e PUID=<uid> -p 1234:1234 linuxserver/<container-name>
docker create --name=transmission -v /etc/localtime:/etc/localtime:ro -v <path to data>:/config -v <path to downloads>:/downloads -e PGID=<gid> -e PUID=<uid> -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 <container-name> /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
<Insert a basic user guide here to get a n00b up and running with the software inside the container.> 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 <container-name>`.
* To monitor the logs of the container in realtime `docker logs -f <container-name>`.
* 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.