From cfebf0a659d3800ece127d7ac779127b69eb982a Mon Sep 17 00:00:00 2001 From: Erik Huelsmann Date: Sat, 1 Mar 2025 18:03:59 +0100 Subject: [PATCH 1/5] Split config and start scripts --- config.sh | 162 +++++++++++++++++++++++++++++++++++++++++++++++++++++ start.sh | 163 +----------------------------------------------------- 2 files changed, 164 insertions(+), 161 deletions(-) create mode 100755 config.sh diff --git a/config.sh b/config.sh new file mode 100755 index 0000000..b5679b6 --- /dev/null +++ b/config.sh @@ -0,0 +1,162 @@ +#!/bin/bash + +set -e + +cd /srv/ledgersmb +[[ -d ./local/conf/ ]] || mkdir ./local/conf/ +if [[ -n "$SSMTP_ROOT" ]]; then + echo "\$SSMTP_ROOT set; parameter is deprecated and will be ignored" + LSMB_HAVE_DEPRECATED=1 +fi +if [[ -n "$SSMTP_FROMLINE_OVERRIDE" ]]; then + echo "\$SSMTP_FROMLINE_OVERRIDE set; parameter is deprecated and will be ignored" + LSMB_HAVE_DEPRECATED=1 +fi +if [[ -n "$SSMTP_MAILHUB" ]]; then + echo "\$SSMTP_MAILHUB set; parameter is deprecated" + if [[ -z "$LSMB_MAIL_SMTPHOST" ]]; then + echo " Deriving \$LSMB_MAIL_SMTPHOST setting from \$SSMTP_MAILHUB" + LSMB_MAIL_SMTPHOST=${SSMTP_MAILHUB%:*} + fi + if [[ -z "$LSMB_MAIL_SMTPPORT" ]]; then + echo " Deriving \$LSMB_MAIL_SMTPPORT setting from \$SSMTP_MAILHUB" + LSMB_MAIL_SMTPPORT=${SSMTP_MAILHUB#*:} + fi + LSMB_HAVE_DEPRECATED=1 +fi +if [[ -n "$SSMTP_HOSTNAME" ]]; then + echo "\$SSMTP_HOSTNAME set; parameter is deprecated" + if [[ -z "$LSMB_MAIL_SMTPSENDER_HOSTNAME" ]]; then + echo " Deriving \$LSMB_MAIL_SMTPSENDER_HOSTNAME setting from \$SSMTP_HOSTNAME" + LSMB_MAIL_SMTPSENDER_HOSTNAME=$SSMTP_HOSTNAME + fi + LSMB_HAVE_DEPRECATED=1 +fi +if [[ -n "$SSMTP_USE_STARTTLS" ]]; then + echo "\$SSMTP_USE_STARTTLS set; parameter is deprecated" + if [[ -z "$LSMB_MAIL_SMTPTLS" ]]; then + echo " Deriving \$LSMB_MAIL_SMTPSENDER_HOSTNAME setting from \$SSMTP_USE_STARTTLS" + LSMB_MAIL_SMTPTLS=$SSMTP_USE_STARTTLS + fi + LSMB_HAVE_DEPRECATED=1 +fi +if [[ -n "$SSMTP_AUTH_USER" ]]; then + echo "\$SSMTP_AUTH_USER set; parameter is deprecated" + if [[ -z "$LSMB_MAIL_SMTPUSER" ]]; then + echo " Deriving \$LSMB_MAIL_SMTPUSER setting from \$SSMTP_AUTH_USER" + LSMB_MAIL_SMTPUSER=$SSMTP_AUTH_USER + fi + LSMB_HAVE_DEPRECATED=1 +fi +if [[ -n "$SSMTP_AUTH_PASS" ]]; then + echo "\$SSMTP_AUTH_PASS set; parameter is deprecated" + if [[ -z "$LSMB_MAIL_SMTPPASS" ]]; then + echo " Deriving \$LSMB_MAIL_SMTPPASS setting from \$SSMTP_AUTH_PASS" + LSMB_MAIL_SMTPPASS=$SSMTP_AUTH_PASS + fi + LSMB_HAVE_DEPRECATED=1 +fi +if [[ -n "$SSMTP_AUTH_METHOD" ]]; then + echo "\$SSMTP_AUTH_METHOD set; parameter is deprecated" + if [[ -z "$LSMB_MAIL_SMTPAUTHMECH" ]]; then + echo " Deriving \$LSMB_MAIL_SMTPAUTHMECH setting from \$SSMTP_AUTH_METHOD" + LSMB_MAIL_SMTPAUTHMECH=$SSMTP_AUTH_METHOD + fi + LSMB_HAVE_DEPRECATED=1 +fi + +if [[ -n "$LSMB_HAVE_DEPRECATED" ]]; then + echo "!!! DEPRECATED \$SSMTP_* PARAMETERS WILL BE REMOVED in the 1.9 image!!!" +fi + +if [[ ! -f ./local/conf/ledgersmb.yaml ]]; then + if [[ "x$LSMB_MAIL_SMTPTLS" == "xyes" ]]; then + tls_mode=starttls + elif [[ "x$LSMB_MAIL_SMTPTLS" == "xraw" ]]; then + tls_mode=ssl + else + tls_mode=none + fi + cat <./local/conf/ledgersmb.yaml +paths: + \$class: Beam::Wire + config: + UI: ./UI/ + UI_cache: lsmb_templates/ + +db: + \$class: LedgerSMB::Database::Factory + connect_data: + host: ${POSTGRES_HOST:-postgres} + port: ${POSTGRES_PORT:-5432} + +mail: + transport: + \$class: Email::Sender::Transport::SMTP + ssl: $tls_mode + +miscellaneous: + \$class: Beam::Wire + config: + proxy_ip: ${PROXY_IP:-172.17.0.1/12} + +ui: + class: LedgerSMB::Template::UI + method: new_UI + lifecycle: eager + args: + cache: + \$ref: paths/UI_cache + root: + \$ref: paths/UI +EOF + + if [[ -n "$LSMB_MAIL_SMTPHOST" ]] + then + if [[ "$LSMB_MAIL_SMTPHOST" == "__CONTAINER_GATEWAY__" ]] + then + LSMB_MAIL_SMTPHOST="$(ip route | awk '/default/ { print $3 }')" + export LSMB_MAIL_SMTPHOST + fi + + cat <./local/conf/ledgersmb.000.yaml +mail: + transport: + host: $LSMB_MAIL_SMTPHOST +EOF + fi + + if [[ -n "$LSMB_MAIL_SMTPPORT" ]] + then + cat <./local/conf/ledgersmb.001.yaml +mail: + transport: + port: $LSMB_MAIL_SMTPPORT +EOF + fi + + if [[ -n "$LSMB_MAIL_SMTPSENDER_HOSTNAME" ]] + then + cat <./local/conf/ledgersmb.002.yaml +mail: + transport: + helo: $LSMB_MAIL_SMTPSENDER_HOSTNAME +EOF + fi + + if [[ -n "$LSMB_MAIL_SMTPUSER" ]] + then + cat <./local/conf/ledgersmb.003.yaml +mail: + transport: + sasl_authenticator: + \$class: Authen::SASL + mechanism: $LSMB_MAIL_SMTPAUTHMECH + callback: + user: $LSMB_MAIL_SMTPUSER + pass: $LSMB_MAIL_SMTPPASS +EOF + fi +fi + +exit 0 diff --git a/start.sh b/start.sh index ef0d871..2ae51f7 100755 --- a/start.sh +++ b/start.sh @@ -1,167 +1,8 @@ #!/bin/bash +$(dirname `readlink -f $BASH_SOURCE`)/config.sh || (echo "Failed configuration" ; exit) + cd /srv/ledgersmb -[[ -d ./local/conf/ ]] || mkdir ./local/conf/ -if [[ -n "$SSMTP_ROOT" ]]; then - echo "\$SSMTP_ROOT set; parameter is deprecated and will be ignored" - LSMB_HAVE_DEPRECATED=1 -fi -if [[ -n "$SSMTP_FROMLINE_OVERRIDE" ]]; then - echo "\$SSMTP_FROMLINE_OVERRIDE set; parameter is deprecated and will be ignored" - LSMB_HAVE_DEPRECATED=1 -fi -if [[ -n "$SSMTP_MAILHUB" ]]; then - echo "\$SSMTP_MAILHUB set; parameter is deprecated" - if [[ -z "$LSMB_MAIL_SMTPHOST" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPHOST setting from \$SSMTP_MAILHUB" - LSMB_MAIL_SMTPHOST=${SSMTP_MAILHUB%:*} - fi - if [[ -z "$LSMB_MAIL_SMTPPORT" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPPORT setting from \$SSMTP_MAILHUB" - LSMB_MAIL_SMTPPORT=${SSMTP_MAILHUB#*:} - fi - LSMB_HAVE_DEPRECATED=1 -fi -if [[ -n "$SSMTP_HOSTNAME" ]]; then - echo "\$SSMTP_HOSTNAME set; parameter is deprecated" - if [[ -z "$LSMB_MAIL_SMTPSENDER_HOSTNAME" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPSENDER_HOSTNAME setting from \$SSMTP_HOSTNAME" - LSMB_MAIL_SMTPSENDER_HOSTNAME=$SSMTP_HOSTNAME - fi - LSMB_HAVE_DEPRECATED=1 -fi -if [[ -n "$SSMTP_USE_STARTTLS" ]]; then - echo "\$SSMTP_USE_STARTTLS set; parameter is deprecated" - if [[ -z "$LSMB_MAIL_SMTPTLS" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPSENDER_HOSTNAME setting from \$SSMTP_USE_STARTTLS" - LSMB_MAIL_SMTPTLS=$SSMTP_USE_STARTTLS - fi - LSMB_HAVE_DEPRECATED=1 -fi -if [[ -n "$SSMTP_AUTH_USER" ]]; then - echo "\$SSMTP_AUTH_USER set; parameter is deprecated" - if [[ -z "$LSMB_MAIL_SMTPUSER" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPUSER setting from \$SSMTP_AUTH_USER" - LSMB_MAIL_SMTPUSER=$SSMTP_AUTH_USER - fi - LSMB_HAVE_DEPRECATED=1 -fi -if [[ -n "$SSMTP_AUTH_PASS" ]]; then - echo "\$SSMTP_AUTH_PASS set; parameter is deprecated" - if [[ -z "$LSMB_MAIL_SMTPPASS" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPPASS setting from \$SSMTP_AUTH_PASS" - LSMB_MAIL_SMTPPASS=$SSMTP_AUTH_PASS - fi - LSMB_HAVE_DEPRECATED=1 -fi -if [[ -n "$SSMTP_AUTH_METHOD" ]]; then - echo "\$SSMTP_AUTH_METHOD set; parameter is deprecated" - if [[ -z "$LSMB_MAIL_SMTPAUTHMECH" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPAUTHMECH setting from \$SSMTP_AUTH_METHOD" - LSMB_MAIL_SMTPAUTHMECH=$SSMTP_AUTH_METHOD - fi - LSMB_HAVE_DEPRECATED=1 -fi - -if [[ -n "$LSMB_HAVE_DEPRECATED" ]]; then - echo "!!! DEPRECATED \$SSMTP_* PARAMETERS WILL BE REMOVED in the 1.9 image!!!" -fi - -if [[ ! -f ./local/conf/ledgersmb.yaml ]]; then - if [[ "x$LSMB_MAIL_SMTPTLS" == "xyes" ]]; then - tls_mode=starttls - elif [[ "x$LSMB_MAIL_SMTPTLS" == "xraw" ]]; then - tls_mode=ssl - else - tls_mode=none - fi - cat <./local/conf/ledgersmb.yaml -paths: - \$class: Beam::Wire - config: - UI: ./UI/ - UI_cache: lsmb_templates/ - -db: - \$class: LedgerSMB::Database::Factory - connect_data: - host: ${POSTGRES_HOST:-postgres} - port: ${POSTGRES_PORT:-5432} - -mail: - transport: - \$class: Email::Sender::Transport::SMTP - ssl: $tls_mode - -miscellaneous: - \$class: Beam::Wire - config: - proxy_ip: ${PROXY_IP:-172.17.0.1/12} - -ui: - class: LedgerSMB::Template::UI - method: new_UI - lifecycle: eager - args: - cache: - \$ref: paths/UI_cache - root: - \$ref: paths/UI -EOF - - if [[ -n "$LSMB_MAIL_SMTPHOST" ]] - then - if [[ "$LSMB_MAIL_SMTPHOST" == "__CONTAINER_GATEWAY__" ]] - then - LSMB_MAIL_SMTPHOST="$(ip route | awk '/default/ { print $3 }')" - export LSMB_MAIL_SMTPHOST - fi - - cat <./local/conf/ledgersmb.000.yaml -mail: - transport: - host: $LSMB_MAIL_SMTPHOST -EOF - fi - - if [[ -n "$LSMB_MAIL_SMTPPORT" ]] - then - cat <./local/conf/ledgersmb.001.yaml -mail: - transport: - port: $LSMB_MAIL_SMTPPORT -EOF - fi - - if [[ -n "$LSMB_MAIL_SMTPSENDER_HOSTNAME" ]] - then - cat <./local/conf/ledgersmb.002.yaml -mail: - transport: - helo: $LSMB_MAIL_SMTPSENDER_HOSTNAME -EOF - fi - - if [[ -n "$LSMB_MAIL_SMTPUSER" ]] - then - cat <./local/conf/ledgersmb.003.yaml -mail: - transport: - sasl_authenticator: - \$class: Authen::SASL - mechanism: $LSMB_MAIL_SMTPAUTHMECH - callback: - user: $LSMB_MAIL_SMTPUSER - pass: $LSMB_MAIL_SMTPPASS -EOF - fi -fi - -# start ledgersmb -# --preload-app allows application initialization to kill the entire -# starman instance (instead of just the worker, which will immediately -# get restarted) on error; it also has a positive effect on memory use - LSMB_CONFIG_FILE=${LSMB_CONFIG_FILE:-./local/conf/ledgersmb.yaml} export LSMB_CONFIG_FILE echo '--------- LEDGERSMB CONFIGURATION: ledgersmb.conf' From 70c3da39183a152784219ecf5fdb3f2ebf1c2961 Mon Sep 17 00:00:00 2001 From: Erik Huelsmann Date: Sat, 1 Mar 2025 18:16:45 +0100 Subject: [PATCH 2/5] Split run.sh out of start.sh --- run.sh | 14 ++++++++++++++ start.sh | 17 +++-------------- 2 files changed, 17 insertions(+), 14 deletions(-) create mode 100755 run.sh diff --git a/run.sh b/run.sh new file mode 100755 index 0000000..9a35a79 --- /dev/null +++ b/run.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +cd /srv/ledgersmb +LSMB_CONFIG_FILE=${LSMB_CONFIG_FILE:-./local/conf/ledgersmb.yaml} +export LSMB_CONFIG_FILE +echo '--------- LEDGERSMB CONFIGURATION: ledgersmb.conf' +cat ${LSMB_CONFIG_FILE} +echo '--------- LEDGERSMB CONFIGURATION --- END' + +# ':5762:' suppresses an uninitialized variable warning in starman +# the last colon means "don't connect using tls"; without it, there's a warning +exec starman --listen 0.0.0.0:5762 --workers ${LSMB_WORKERS:-5} \ + -I lib -I old/lib \ + --preload-app bin/ledgersmb-server.psgi diff --git a/start.sh b/start.sh index 2ae51f7..32f507b 100755 --- a/start.sh +++ b/start.sh @@ -1,16 +1,5 @@ #!/bin/bash -$(dirname `readlink -f $BASH_SOURCE`)/config.sh || (echo "Failed configuration" ; exit) - -cd /srv/ledgersmb -LSMB_CONFIG_FILE=${LSMB_CONFIG_FILE:-./local/conf/ledgersmb.yaml} -export LSMB_CONFIG_FILE -echo '--------- LEDGERSMB CONFIGURATION: ledgersmb.conf' -cat ${LSMB_CONFIG_FILE} -echo '--------- LEDGERSMB CONFIGURATION --- END' - -# ':5762:' suppresses an uninitialized variable warning in starman -# the last colon means "don't connect using tls"; without it, there's a warning -exec starman --listen 0.0.0.0:5762 --workers ${LSMB_WORKERS:-5} \ - -I lib -I old/lib \ - --preload-app bin/ledgersmb-server.psgi +home_dir="$(dirname `readlink -f $BASH_SOURCE`)" +"$home_dir/config.sh" || (echo "Failed configuration" ; exit) +exec "$home_dir/run.sh" From c036e6dddf72fe6677fed379a07ba0f6e0967bae Mon Sep 17 00:00:00 2001 From: Erik Huelsmann Date: Sat, 1 Mar 2025 21:00:20 +0100 Subject: [PATCH 3/5] Copy config and run scripts into the resulting image --- Dockerfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Dockerfile b/Dockerfile index 0bff717..380194a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -125,6 +125,8 @@ ENV POSTGRES_PORT=5432 ENV DEFAULT_DB=lsmb COPY start.sh /usr/local/bin/start.sh +COPY config.sh /usr/local/bin/config.sh +COPY run.sh /usr/local/bin/run.sh RUN chmod +x /usr/local/bin/start.sh && \ mkdir -p /var/www && \ From b290e69a3b4f94e7a8e02d36017e3487a53ede78 Mon Sep 17 00:00:00 2001 From: Erik Huelsmann Date: Tue, 5 Aug 2025 11:46:35 +0200 Subject: [PATCH 4/5] Incorporate reviews from Copilot --- Dockerfile | 2 +- config.sh | 2 +- start.sh | 7 ++++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/Dockerfile b/Dockerfile index 854a56b..483011e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -68,7 +68,7 @@ COPY start.sh /usr/local/bin/start.sh COPY config.sh /usr/local/bin/config.sh COPY run.sh /usr/local/bin/run.sh -RUN chmod +x /usr/local/bin/start.sh && \ +RUN chmod +x /usr/local/bin/start.sh /usr/local/bin/config.sh /usr/local/bin/run.sh && \ mkdir -p /var/www && \ mkdir -p /srv/ledgersmb/local/conf && \ chown -R www-data /srv/ledgersmb/local diff --git a/config.sh b/config.sh index b5679b6..f7a3635 100755 --- a/config.sh +++ b/config.sh @@ -35,7 +35,7 @@ fi if [[ -n "$SSMTP_USE_STARTTLS" ]]; then echo "\$SSMTP_USE_STARTTLS set; parameter is deprecated" if [[ -z "$LSMB_MAIL_SMTPTLS" ]]; then - echo " Deriving \$LSMB_MAIL_SMTPSENDER_HOSTNAME setting from \$SSMTP_USE_STARTTLS" + echo " Deriving \$LSMB_MAIL_SMTPTLS setting from \$SSMTP_USE_STARTTLS" LSMB_MAIL_SMTPTLS=$SSMTP_USE_STARTTLS fi LSMB_HAVE_DEPRECATED=1 diff --git a/start.sh b/start.sh index 975926e..d1b1a9d 100755 --- a/start.sh +++ b/start.sh @@ -1,5 +1,6 @@ #!/bin/bash -home_dir="$(dirname `readlink -f $BASH_SOURCE`)" -"$home_dir/config.sh" || (echo "Failed configuration" ; exit) -exec "$home_dir/run.sh" \ No newline at end of file +home_dir="$(dirname $(readlink -f $BASH_SOURCE))" +"$home_dir/config.sh" || { echo "Failed configuration" ; exit 1 } + +exec "$home_dir/run.sh" From 0690e55c43310297e06d5789df14312b218bb5ed Mon Sep 17 00:00:00 2001 From: Erik Huelsmann Date: Tue, 5 Aug 2025 11:46:57 +0200 Subject: [PATCH 5/5] Move last 'config' responsibility into config.sh --- config.sh | 6 ++++++ run.sh | 5 ----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/config.sh b/config.sh index f7a3635..4292331 100755 --- a/config.sh +++ b/config.sh @@ -159,4 +159,10 @@ EOF fi fi +LSMB_CONFIG_FILE=${LSMB_CONFIG_FILE:-./local/conf/ledgersmb.yaml} +export LSMB_CONFIG_FILE +echo "--------- LEDGERSMB CONFIGURATION: $LSMB_CONFIG_FILE" +cat ${LSMB_CONFIG_FILE} +echo '--------- LEDGERSMB CONFIGURATION --- END' + exit 0 diff --git a/run.sh b/run.sh index 9a35a79..d76c8d9 100755 --- a/run.sh +++ b/run.sh @@ -1,11 +1,6 @@ #!/bin/bash cd /srv/ledgersmb -LSMB_CONFIG_FILE=${LSMB_CONFIG_FILE:-./local/conf/ledgersmb.yaml} -export LSMB_CONFIG_FILE -echo '--------- LEDGERSMB CONFIGURATION: ledgersmb.conf' -cat ${LSMB_CONFIG_FILE} -echo '--------- LEDGERSMB CONFIGURATION --- END' # ':5762:' suppresses an uninitialized variable warning in starman # the last colon means "don't connect using tls"; without it, there's a warning