Merge pull request #9 from sparklyballs/badges

Badges

Dockerfile

@@ -1,26 +1,14 @@
-FROM linuxserver/baseimage
+FROM lsiobase/alpine
+MAINTAINER sparklyballs
 
-MAINTAINER Sparklyballs <sparklyballs@linuxserver.io>
+# install packages
+RUN \
+ apk add --no-cache \
+	transmission-daemon
 
-ENV APTLIST="transmission-daemon"
+# copy local files
+COPY root/ /
 
-# add repository
-RUN add-apt-repository ppa:transmissionbt/ppa && \
-
-# install packages
-apt-get update -q && \
-apt-get install $APTLIST -qy && \
-
-# cleanup
-apt-get clean && rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/*
-
-#Adding Custom files
-ADD init/ /etc/my_init.d/
-ADD services/ /etc/service/
-#ADD cron/ /etc/cron.d/
-ADD defaults/ /defaults/
-RUN chmod -v +x /etc/service/*/run && chmod -v +x /etc/my_init.d/*.sh
-   
-# Volumes and Ports
-VOLUME /config /downloads /watch 
+# ports and volumes
 EXPOSE 9091 51413
+VOLUME /config /downloads /watch

README.md

@@ -1,21 +1,32 @@
-![https://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
+![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
 
-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`.
+The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at:
+* [forum.linuxserver.io](https://forum.linuxserver.io)
+* [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`
+* [Podcast](https://www.linuxserver.io/index.php/category/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
 
 # linuxserver/transmission
+[![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](http://jenkins.linuxserver.io:8080/buildStatus/icon?job=Dockers/LinuxServer.io/linuxserver-transmission)](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io/job/linuxserver-transmission/)
+[hub]: https://hub.docker.com/r/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/)
 
+[![transmission](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/transmission.png)][transurl]
+[transurl]: https://www.transmissionbt.com/
+
 ## 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 \
+-e TZ=<timezone> \
+-p 9091:9091 -p 51413:51413 \
+-p 51413:51413/udp \
 linuxserver/transmission
 ```
 
@@ -23,34 +34,41 @@ linuxserver/transmission
 
 * `-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
 * `-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 phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`.
+It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`.
 
 ### 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).
+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" ™.
 
-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.
+In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
+
+```
+  $ id <dockeruser>
+    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
+```
 
 ## 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.
 
 
-## Updates
+## Info
 
-* Upgrade to the latest version simply `docker restart transmission`.
 * To monitor the logs of the container in realtime `docker logs -f transmission`.
 
 
 
 ## Versions
-+ **06.12.2015:** Separate mapping for watch folder.
-+ **16.11.2015:** Initial Release. 
+
++ **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. 
 

init/30_set_config.sh

@@ -1,7 +0,0 @@
-#!/bin/bash
-
-mkdir -p /downloads/{complete,incomplete} /watch
-
-[[ ! -f /config/settings.json ]] && cp /defaults/settings.json /config/settings.json
-
-chown abc:abc /watch /config/settings.json /downloads /downloads/incomplete /downloads/complete

root/etc/cont-init.d/20-config

@@ -0,0 +1,17 @@
+#!/usr/bin/with-contenv bash
+
+# make folders
+mkdir -p \
+	/downloads/{complete,incomplete} /watch
+
+# copy config
+[[ ! -f /config/settings.json ]] && cp \
+	/defaults/settings.json /config/settings.json
+
+# permissions
+chown abc:abc \
+	/config/settings.json \
+	/downloads \
+	/downloads/complete \
+	/downloads/incomplete \
+	/watch

root/etc/services.d/transmission/run

@@ -0,0 +1,5 @@
+#!/usr/bin/with-contenv bash
+
+exec \
+	s6-setuidgid abc /usr/bin/transmission-daemon \
+	-g /config -c /watch -f

services/transmission/run

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-/sbin/setuser abc /usr/bin/transmission-daemon -g /config -c /watch -f