Merge pull request #30 from linuxserver/stdout-logging-opt

Author: thespad

Jenkinsfile

@@ -36,7 +36,7 @@ pipeline {
     CI_PORT='80'
     CI_SSL='false'
     CI_DELAY='120'
-    CI_DOCKERENV='TZ=US/Pacific'
+    CI_DOCKERENV=''
     CI_AUTH=''
     CI_WEBPATH=''
   }

README.md

@@ -86,6 +86,7 @@ services:
       - PUID=1000
       - PGID=1000
       - TZ=Etc/UTC
+      - LOG_TO_STDOUT= #optional
     volumes:
       - /path/to/syslog-ng/config:/config
       - /path/to/log:/var/log #optional
@@ -104,6 +105,7 @@ docker run -d \
   -e PUID=1000 \
   -e PGID=1000 \
   -e TZ=Etc/UTC \
+  -e LOG_TO_STDOUT= `#optional` \
   -p 514:5514/udp \
   -p 601:6601/tcp \
   -p 6514:6514/tcp \
@@ -125,6 +127,7 @@ Containers are configured using parameters passed at runtime (such as those abov
 | `-e PUID=1000` | for UserID - see below for explanation |
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
+| `-e LOG_TO_STDOUT=` | If set to `true` container will log to stdout, otherwise will log to `/config/log/`. |
 | `-v /config` | Stores config and application files |
 | `-v /var/log` | Stores logs collected by the syslog-ng service |
 | `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
@@ -290,6 +293,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **24.09.24:** - Add opt to log to stdout.
 * **24.05.24:** - Rebase to Alpine 3.20.
 * **31.01.24:** - Rebase to Alpine 3.19.
 * **11.06.23:** - Rebase to Alpine 3.18, deprecate armhf.

jenkins-vars.yml

@@ -24,6 +24,6 @@ repo_vars:
   - CI_PORT='80'
   - CI_SSL='false'
   - CI_DELAY='120'
-  - CI_DOCKERENV='TZ=US/Pacific'
+  - CI_DOCKERENV=''
   - CI_AUTH=''
   - CI_WEBPATH=''

readme-vars.yml

@@ -19,9 +19,12 @@ development_versions: false
 # container parameters
 common_param_env_vars_enabled: true
 param_container_name: "{{ project_name }}"
+opt_param_usage_include_env: true
+opt_param_env_vars:
+  - { env_var: "LOG_TO_STDOUT", env_value: "", desc: "If set to `true` container will log to stdout, otherwise will log to `/config/log/`." }
 param_usage_include_vols: true
 param_volumes:
-  - { vol_path: "/config", vol_host_path: "/path/to/syslog-ng/config", desc: "Stores config and application files" }
+  - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Stores config and application files" }
 opt_param_usage_include_vols: true
 opt_param_volumes:
   - { vol_path: "/var/log", vol_host_path: "/path/to/log", desc: "Stores logs collected by the syslog-ng service" }
@@ -44,6 +47,7 @@ app_setup_block: |
 
 # changelog
 changelogs:
+  - { date: "24.09.24:", desc: "Add opt to log to stdout." }
   - { date: "24.05.24:", desc: "Rebase to Alpine 3.20." }
   - { date: "31.01.24:", desc: "Rebase to Alpine 3.19." }
   - { date: "11.06.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }

root/etc/s6-overlay/s6-rc.d/log-syslog-ng/run

@@ -1,5 +1,10 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
-exec \
-    s6-setuidgid abc s6-log n30 s10000000 S30000000 T !"gzip -nq9" /config/log/
+if [[ "${LOG_TO_STDOUT,,}" == "true" ]]; then
+    exec \
+        s6-setuidgid abc s6-log +.* 1
+else
+    exec \
+        s6-setuidgid abc s6-log n30 s10000000 S30000000 T !"gzip -nq9" /config/log/
+fi