Add LOG_TO_STDOUT variable + documentation (#1379)

DockerEnv

@@ -88,3 +88,4 @@
 #WEBPROXY_USERNAME=
 #WEBPROXY_PASSWORD=
 #DOCKER_LOG=false
+#LOG_TO_STDOUT=false

Dockerfile

@@ -136,7 +136,8 @@ ENV OPENVPN_USERNAME=**None** \
     WEBPROXY_USERNAME= \
     WEBPROXY_PASSWORD= \
     HEALTH_CHECK_HOST=google.com \
-    DOCKER_LOG=false
+    DOCKER_LOG=false \
+    LOG_TO_STDOUT=false
 
 HEALTHCHECK --interval=5m CMD /etc/scripts/healthcheck.sh
 

Dockerfile.alpine

@@ -126,6 +126,7 @@ ENV OPENVPN_USERNAME=**None** \
     WEBPROXY_USERNAME= \
     WEBPROXY_PASSWORD= \
     DOCKER_LOG=false \
+    LOG_TO_STDOUT=false \
     HEALTH_CHECK_HOST=google.com
 
 HEALTHCHECK --interval=5m CMD /etc/scripts/healthcheck.sh

Dockerfile.armhf

@@ -130,6 +130,7 @@ ENV OPENVPN_USERNAME=**None** \
     WEBPROXY_USERNAME= \
     WEBPROXY_PASSWORD= \
     DOCKER_LOG=false \
+    LOG_TO_STDOUT=false \
     HEALTH_CHECK_HOST=google.com
 
 HEALTHCHECK --interval=5m CMD /etc/scripts/healthcheck.sh

docs/arguments.md

@@ -105,3 +105,11 @@ This might lead to the default route (your untunneled connection) to be used.
 To drop the default route set the environment variable `DROP_DEFAULT_ROUTE` to `true`.
 
 *Note*: This is not compatible with all VPNs. You can check your iptables routing with the `ip r` command in a running container.
+
+### Changing logging locations
+
+By default Transmission will log to a file in `TRANSMISSION_HOME/transmission.log`. 
+
+To log to stdout instead set the environment variable `LOG_TO_STDOUT` to `true`.
+
+*Note*: By default stdout is what container engines read logs from. Set this to true to have Tranmission logs in commands like `docker logs` and `kubectl logs`. OpenVPN currently only logs to stdout.

transmission/environment-variables.tmpl

@@ -97,5 +97,6 @@ export DROP_DEFAULT_ROUTE={{ .Env.DROP_DEFAULT_ROUTE }}
 # Support using transmission ids for transmission paths
 export GLOBAL_APPLY_PERMISSIONS={{ .Env.GLOBAL_APPLY_PERMISSIONS }}
 
-#Support logging to docker logs
+# Support logging to stdout which docker logs uses, mark either true
-export DOCKER_LOG={{ .Env.DOCKER_LOG }}
+export DOCKER_LOG={{ .Env.DOCKER_LOG }} # DEPRECIATED -- variable name does not reflect usage
+export LOG_TO_STDOUT={{ .Env.LOG_TO_STDOUT }} # Updated variable name

transmission/start.sh

@@ -60,7 +60,7 @@ if [[ "true" = "$DROP_DEFAULT_ROUTE" ]]; then
   ip r del default || exit 1
 fi
 
-if [[ "true" = "$DOCKER_LOG" ]]; then
+if [[ "true" = "$DOCKER_LOG" || "true" = "$LOG_TO_STDOUT" ]]; then
   LOGFILE=/dev/stdout
 else
   LOGFILE=${TRANSMISSION_HOME}/transmission.log

transmission/userSetup.sh

@@ -13,7 +13,7 @@ if [ -n "$PUID" ] && [ ! "$(id -u root)" -eq "$PUID" ]; then
         groupmod -o -g "$PGID" ${RUN_AS};
     fi
 
-    if [[ "true" = "$DOCKER_LOG" ]]; then
+    if [[ "true" = "$DOCKER_LOG" || "true" = "$LOG_TO_STDOUT" ]]; then
       chown ${RUN_AS}:${RUN_AS} /dev/stdout
     fi