Merge pull request #170 from jkossis/add-slave-config

Add configuration for running smokeping in slave mode
linuxserver · Mar 22, 2024 · da61e11 · da61e11 · r2ixuz · Mar 23, 2024
2 parents e7be439 + d88cc5c
commit da61e11
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 2 deletions.
diff --git a/readme-vars.yml b/readme-vars.yml
@@ -24,6 +24,11 @@ param_ports:
 param_usage_include_env: true
 param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
+opt_param_usage_include_env: true
+opt_param_env_vars:
+ - { env_var: "MASTER_URL", env_value: "http://<master-host-ip>:80/smokeping/", desc: "Specify the master url to connect to. Used when in slave mode."}
+ - { env_var: "SHARED_SECRET", env_value: "password", desc: "Specify the master shared secret for this host. Used when in slave mode."}
+ - { env_var: "CACHE_DIR", env_value: "/tmp", desc: "Specify the cache directory for this host. Used when in slave mode."}
 
 # application setup block
 app_setup_block_enabled: true
@@ -34,9 +39,11 @@ app_setup_block: |
  * To reload the configuration without restarting the container, run `docker exec smokeping pkill -f -HUP '/usr/bin/perl /usr/s?bin/smokeping(_cgi)?'`, where `smokeping` is the container ID.
  * To restart the container, run `docker restart smokeping`, where `smokeping` is the container ID.
  * Note that the default `Targets` file includes items that may or may not work. These are simply to provide examples of configuration.
+ * Slave setup: modify the `Targets`, `Slaves`, and `smokeping_secrets` files on the master host, per [the documentation](https://manpages.ubuntu.com/manpages/trusty/en/man7/smokeping_master_slave.7.html).
 
 # changelog
 changelogs:
+ - { date: "22.03.24:", desc: "Adding ability to run as a slave."}
  - { date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
  - { date: "29.11.23:", desc: "Bump tcpping to 1.8." }
  - { date: "21.11.23:", desc: "Add support for IRTT Probes." }

diff --git a/root/defaults/smokeping_secrets b/root/defaults/smokeping_secrets
@@ -0,0 +1,3 @@
+host1:mysecret
+host2:yoursecret
+boomer:lkasdf93uhhfdfddf
diff --git a/root/etc/s6-overlay/s6-rc.d/init-smokeping-config/run b/root/etc/s6-overlay/s6-rc.d/init-smokeping-config/run
@@ -43,6 +43,14 @@ if [[ ! -L /etc/apache2/httpd.conf ]]; then
  ln -sf /config/httpd.conf /etc/apache2/httpd.conf
 fi
 
+if [[ ! -e /config/smokeping_secrets ]]; then
+ cp /defaults/smokeping_secrets /config/smokeping_secrets
+fi
+
+if [[ ! -L /etc/smokeping/smokeping_secrets ]]; then
+ ln -sf /config/smokeping_secrets /etc/smokeping/smokeping_secrets
+fi
+
 if [[ -e /config/ssmtp.conf ]]; then
  cp /config/ssmtp.conf /etc/ssmtp/ssmtp.conf
 fi

diff --git a/root/etc/s6-overlay/s6-rc.d/svc-smokeping/run b/root/etc/s6-overlay/s6-rc.d/svc-smokeping/run
@@ -1,5 +1,11 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
-exec \
- s6-setuidgid abc /usr/sbin/smokeping --config="/etc/smokeping/config" --nodaemon
+if [ -n "${MASTER_URL}" ] && [ -n "${SHARED_SECRET}" ] && [ -n "${CACHE_DIR}" ]; then
+ install -g abc -o abc -m 400 -D <(echo $SHARED_SECRET) /var/smokeping/secret.txt
+ exec \
+ s6-setuidgid abc /usr/sbin/smokeping --master-url="${MASTER_URL}" --cache-dir="${CACHE_DIR}" --shared-secret="/var/smokeping/secret.txt" --nodaemon
+else
+ exec \
+ s6-setuidgid abc /usr/sbin/smokeping --config="/etc/smokeping/config" --nodaemon
+fi