Merge pull request #18 from phendryx/blocklist-cleanup

Blocklist script cleanup

.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,7 @@
 <!--- Provide a general summary of the issue in the Title above -->
 
 [linuxserverurl]: https://linuxserver.io
-[![linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)][linuxserverurl]
+[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
 	
 
 <!--- If you have an issue with the project, please provide us with the following information -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 <!--- Provide a general summary of your changes in the Title above -->
 
 [linuxserverurl]: https://linuxserver.io
-[![linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)][linuxserverurl]
+[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
 	
 
 <!--- Before submitting a pull request please check the following -->

Dockerfile

@@ -1,9 +1,17 @@
 FROM lsiobase/alpine
 MAINTAINER sparklyballs
 
+# set version label
+ARG BUILD_DATE
+ARG VERSION
+LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
+
 # install packages
 RUN \
  apk add --no-cache \
+	curl \
+	jq \
+	transmission-cli \
 	transmission-daemon
 
 # copy local files

README.md

@@ -1,9 +1,9 @@
 [linuxserverurl]: https://linuxserver.io
 [forumurl]: https://forum.linuxserver.io
-[ircurl]: https://www.linuxserver.io/index.php/irc/
-[podcasturl]: https://www.linuxserver.io/index.php/category/podcast/
+[ircurl]: https://www.linuxserver.io/irc/
+[podcasturl]: https://www.linuxserver.io/podcast/
 
-[![linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)][linuxserverurl]
+[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
 
 The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
 * [forum.linuxserver.io][forumurl]
@@ -11,7 +11,7 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f
 * [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
-[![](https://images.microbadger.com/badges/image/linuxserver/transmission.svg)](http://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](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/)
+[![](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)](http://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](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/)
@@ -33,7 +33,13 @@ docker create --name=transmission \
 linuxserver/transmission
 ```
 
-**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. 
+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
+http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
+
 
 * `-p 9091` 
 * `-p 51413` - the port(s)
@@ -61,15 +67,47 @@ In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as bel
 
 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.
+
+this requires 3 settings to be changed in the settings.json file.
+
+`Make sure the container is stopped before editing these settings.`
+
+`"rpc-authentication-required": true,` - check this, the default is false, change to true.
+
+`"rpc-username": "transmission",` substitute transmission for your chosen user name, this is just an example.
+
+`rpc-password` will be a hash starting with {, replace everything including the { with your chosen password, keeping the quotes.
+
+Transmission will convert it to a hash when you restart the container after making the above edits.
+
+## Updating Blocklists Automatically
+
+This requires `"blocklist-enabled": true,` to be set. By setting this to true, it is assumed you have also populated `blocklist-url` with a valid block list.
+
+The automatic update is a shell script that downloads a blocklist from the url stored in the settings.json, gunzips it, and restarts the transmission daemon.
+
+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 
+
+`docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission`
+
+* image version number
+
+`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/transmission`
 
 
 ## Versions
 
++ **16.10.16:** Blocklist autoupdate with optional authentication.
++ **14.10.16:** Add version layer information.
++ **23.09.16:** Add information about securing the webui to README..
++ **21.09.16:** Add curl package.
 + **09.09.16:** Add layer badges to README.
 + **28.08.16:** Add badges to README.
 + **09.08.16:** Rebase to alpine linux.

root/defaults/blocklist-update.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/with-contenv bash
+
+BLOCKLIST_ENABLED=`jq -r '.["blocklist-enabled"]' /config/settings.json`
+BLOCKLIST_URL=`jq -r '.["blocklist-url"]' /config/settings.json | sed 's/\&/\&/g'`
+
+if [ $BLOCKLIST_ENABLED == true ]; then
+	mkdir -p /tmp/blocklists
+	rm -rf /tmp/blocklists/*
+	cd /tmp/blocklists
+	wget -q -O blocklist.gz "$BLOCKLIST_URL"
+	if [ $? == 0 ]; then
+		gunzip *.gz
+		if [ $? == 0 ]; then
+			chmod go+r *
+			rm -rf /config/blocklists/*
+			cp /tmp/blocklists/* /config/blocklists
+			s6-svc -h /var/run/s6/services/transmission
+		fi
+	fi
+fi

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

@@ -8,10 +8,17 @@ mkdir -p \
 [[ ! -f /config/settings.json ]] && cp \
 	/defaults/settings.json /config/settings.json
 
+# copy blocklist-update script
+[[ ! -f /config/blocklist-update.sh ]] && cp \
+	/defaults/blocklist-update.sh /config/blocklist-update.sh
+
 # permissions
 chown abc:abc \
 	/config/settings.json \
+	/config/blocklist-update.sh \
 	/downloads \
 	/downloads/complete \
 	/downloads/incomplete \
 	/watch
+
+chmod 755 /config/blocklist-update.sh

root/etc/crontabs/root

@@ -0,0 +1,10 @@
+# do daily/weekly/monthly maintenance
+# min   hour    day     month   weekday command
+*/15    *       *       *       *       run-parts /etc/periodic/15min
+0       *       *       *       *       run-parts /etc/periodic/hourly
+0       2       *       *       *       run-parts /etc/periodic/daily
+0       3       *       *       6       run-parts /etc/periodic/weekly
+0       5       1       *       *       run-parts /etc/periodic/monthly
+
+# run daily blocklist update
+0 3 * * * /config/blocklist-update.sh 2>&1

root/etc/services.d/cron/run

@@ -0,0 +1,3 @@
+#!/usr/bin/with-contenv bash
+
+/usr/sbin/crond -f -S -l 0 -c /etc/crontabs