* Automatic Dockerfile update by release process

We've seen multiple users thinking that simple creation of two containers
is enough, whereas this isn't the case: at the very least, the deprecated
`--link` docker option must be used, but more compliant is the use of
custom networks and bridges. Docker-compose sets all that up automatically,
so don't suggest going without docker-compose is simpler.

Dockerfile

@@ -2,8 +2,8 @@ FROM        debian:stretch-slim
 MAINTAINER  Freelock john@freelock.com
 
 # Build time variables
-ARG LSMB_VERSION="1.7.22"
-ARG LSMB_DL_DIR="Releases"
+ENV LSMB_VERSION 1.6.24
+
 
 # Install Perl, Tex, Starman, psql client, and all dependencies
 # Without libclass-c3-xs-perl, performance is terribly slow...
@@ -16,11 +16,6 @@ ARG LSMB_DL_DIR="Releases"
 # Installing psql client directly from instructions at https://wiki.postgresql.org/wiki/Apt
 # That mitigates issues where the PG instance is running a newer version than this container
 
-# for Buster, add:
-#    libhtml-escape-perl \
-#    libplack-middleware-builder-conditionals-perl \
-#    libplack-request-withencoding-perl \
-#libversion-compare-perl
 RUN echo -n "APT::Install-Recommends \"0\";\nAPT::Install-Suggests \"0\";\n" >> /etc/apt/apt.conf && \
   mkdir -p /usr/share/man/man1/ && \
   mkdir -p /usr/share/man/man2/ && \
@@ -33,11 +28,10 @@ RUN echo -n "APT::Install-Recommends \"0\";\nAPT::Install-Suggests \"0\";\n" >>
   DEBIAN_FRONTEND="noninteractive" apt-get dist-upgrade -y -q && \
   DEBIAN_FRONTEND="noninteractive" apt-get -y -q install \
     wget ca-certificates gnupg \
-    libcgi-emulate-psgi-perl libconfig-inifiles-perl \
+    libcgi-emulate-psgi-perl libcgi-simple-perl libconfig-inifiles-perl \
     libdbd-pg-perl libdbi-perl libdata-uuid-perl libdatetime-perl \
-    libdatetime-format-strptime-perl \
-    libio-stringy-perl \
-    libcpanel-json-xs-perl liblist-moreutils-perl \
+    libdatetime-format-strptime-perl libio-stringy-perl \
+    libjson-xs-perl libcpanel-json-xs-perl liblist-moreutils-perl \
     liblocale-maketext-perl liblocale-maketext-lexicon-perl \
     liblog-log4perl-perl libmime-lite-perl libmime-types-perl \
     libmath-bigint-gmp-perl libmodule-runtime-perl libmoose-perl \
@@ -48,12 +42,12 @@ RUN echo -n "APT::Install-Recommends \"0\";\nAPT::Install-Suggests \"0\";\n" >>
     libpgobject-util-dbadmin-perl libplack-perl \
     libplack-middleware-reverseproxy-perl \
     libtemplate-perl libtext-csv-perl libtext-csv-xs-perl \
-    libtext-markdown-perl  libxml-simple-perl \
+    libtext-markdown-perl libxml-simple-perl \
     libnamespace-autoclean-perl \
-    libfile-find-rule-perl \
+    libimage-size-perl \
     libtemplate-plugin-latex-perl libtex-encode-perl \
     libclass-c3-xs-perl libclass-accessor-lite-perl \
-    libnet-cidr-lite-perl \
+    libnet-cidr-lite-perl libtest-requires-perl \
     texlive-latex-recommended texlive-fonts-recommended \
     texlive-xetex fonts-liberation \
     starman \
@@ -65,7 +59,7 @@ RUN echo -n "APT::Install-Recommends \"0\";\nAPT::Install-Suggests \"0\";\n" >>
   DEBIAN_FRONTEND="noninteractive" apt-get -q -y update && \
   DEBIAN_FRONTEND="noninteractive" apt-get -q -y install postgresql-client && \
   DEBIAN_FRONTEND="noninteractive" apt-get -q -y install git cpanminus make gcc libperl-dev && \
-  wget --quiet -O /tmp/ledgersmb-$LSMB_VERSION.tar.gz "https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz" && \
+  wget --quiet -O /tmp/ledgersmb-$LSMB_VERSION.tar.gz "https://download.ledgersmb.org/f/Releases/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz" && \
   tar -xzf /tmp/ledgersmb-$LSMB_VERSION.tar.gz --directory /srv && \
   rm -f /tmp/ledgersmb-$LSMB_VERSION.tar.gz && \
   cpanm --notest \

README.md

@@ -1,18 +1,14 @@
 # ledgersmb-docker
-
 Dockerfile for LedgerSMB Docker image
 
 # Supported tags
 
 - `1.8` - Preview version for the 1.8 branch
 - `1.7`, `1.7.x`, `latest` - Latest official release from 1.7 branch
-- `1.6`, `1.6.x` - Latest official release from 1.6 branch 
-- `1.5`, `1.5.30` - Last official release from 1.5 branch
-- `1.4`, `1.4.42` - Last official release from 1.4 branch
-- `master` - Master branch from git, unstable
+- `1.6`, `1.6.x`, `latest` - Latest release tarball from 1.6 branch
+- `1.5`, `1.5.x` - Latest release tarball from 1.5 branch
+- `1.4`, `1.4.x` - Latest tagged release of git 1.4 branch
 
-Containers supporting the development process are provided
-through the ledgersmb-dev-docker project. See https://github.com/ledgersmb/ledgersmb-dev-docker/blob/master/README.md#getting-started.
 
 # What is LedgerSMB?
 
@@ -29,9 +25,9 @@ This image is designed to be used in conjunction with a running PostgreSQL
 instance (such as may be provided through a separate image).
 
 This image exposes port 5762 running a Starman HTTP application server. We
-do recommend not exposing this port publicly, because
+do not recommend exposing this port publicly, because
 
-1. The Starman author recommends not exposing it
+1. The Starman author recommends it
 2. We strongly recommend TLS encryption of all application traffic
 
 While the exposed port can be used for quick evaluation, it's recommended
@@ -40,45 +36,33 @@ to add the TLS layer by applying Nginx or Apache as reverse proxy.
 Enabling optional functionalities such as outgoing e-mail and printing
 could require additional setup of a mail service or CUPS printer service.
 
-# How to use this image
+# Quickstart
 
-This image can be installed either automatically with the Docker compose file
-or manually with docker only.
+The quickest way to get this image up and running is by using the
+`docker-compose` file available through the GitHub repository at:
 
-## Docker-Compose installation and start
+  https://github.com/ledgersmb/ledgersmb-docker/blob/1.7/docker-compose.yml
 
-This image provides `docker-compose.yml` which can be used to pull related
-images, install them, establish an internal network for their communications,
-adjust environment variables, start and stop LedgerSMB. The only instructions
-required, after the optional edition of the file to adjust the environment
-variables, are:
-
-```plain
- $ docker-compose pull
- $ docker-compose up
-```
-
-This will set up two containers: (1) a PostgreSQL container with persistent
-storage which is retained between container updates and (2) a LedgerSMB
-container configured to connect to the PostgreSQL container as its database
-server.
-
-The database username and password are:
+which sets up both this image and a supporting database image for
+production purposes (i.e. with persistent (database) data. The database
+username and password are:
 
 ```plain
    username: postgres
    password: abc
 ```
 
-From here, follow the steps as detailed in the instructions for
-[preparing for first use](https://ledgersmb.org/content/preparing-ledgersmb-17-first-use).
+The docker-compose file does *not* set up an Nginx or Apache reverse proxy
+with TLS 1.2/1.3 support -- a requirement if you want to access your
+installation over any type of network (and especially the internet).
+
 
 ## Manual installation
 
 This section assumes availability of a PostgreSQL server to attach to the
 LedgerSMB image as the database server.
 
-### Start LedgerSMB
+## Start LedgerSMB
 
 ```plain
  $ docker run -d -p 5762:5762 --name myledger \
@@ -92,7 +76,7 @@ http://localhost:5762/setup.pl and http://localhost:5762/login.pl.
 Below are more variables which determine container configuration,
 like `POSTGRES_HOST` above.
 
-# Set up LedgerSMB
+## Set up LedgerSMB
 
  * Visit http://myledger:5762/setup.pl.
  * Log in with the "postgres" user and the password `abc` as given above -
@@ -148,18 +132,21 @@ affect the performance experience of users.
 
 ## Mail configuration
 
-### Before 1.8.0
+The docker image uses `ssmtp` to send mail.
 
-These variables are used to set outgoing SMTP defaults.
-
-* `SSMTP_ROOT` (config: `Root` -- DEPRECATED)
+* `SSMTP_ROOT` (config: `Root`)
 * `SSMTP_MAILHUB` (config: `Mailhub`)
 * `SSMTP_HOSTNAME` (config: `Hostname`)
 * `SSMTP_USE_STARTTLS` (config: `UseSTARTTLS`)
 * `SSMTP_AUTH_USER` (config: `AuthUser`)
 * `SSMTP_AUTH_PASS` (config: `AuthPass`)
-* `SSMTP_AUTH_METHOD` (config: `AuthMethod` -- DEPRECATED)
-* `SSMTP_FROMLINE_OVERRIDE` (config: `FromLineOverride` -- DEPRECATED)
+* `SSMTP_AUTH_METHOD` (config: `AuthMethod`)
+* `SSMTP_FROMLINE_OVERRIDE` (config: `FromLineOverride`)
+
+These variables are used to set outgoing SMTP defaults.
+
+To set the outgoing email address, set `SSMTP_ROOT` and `SSMTP_HOSTNAME` at
+a minimum.
 
 `SSMTP_MAILHUB` defaults to the default docker0 interface, so if your host is
 already configured to relay mail, this should relay successfully with only
@@ -170,25 +157,6 @@ Use the [ssmtp.conf man
 page](https://www.systutorials.com/docs/linux/man/5-ssmtp.conf/) to look up
 the meaning and function of each of the mail configuration keys.
 
-### 1.8.0 and higher (under development)
-
-As of 1.8.0, the image is based on Debian Buster instead of Debian Stretch;
-with Buster, the `ssmtp` program has been removed from Debian, this image
-had to change strategy. The main application always came with built-in e-mail
-yet with the deprecation, the abilities have expanded.
-
-The following parameters are now supported to set mail preferences:
-
-* `LSMB_MAIL_SMTPHOST`
-* `LSMB_MAIL_SMTPPORT`
-* `LSMB_MAIL_SMTPTLS`
-* `LSMB_MAIL_SMTPSENDER_HOSTNAME`
-* `LSMB_MAIL_SMTPUSER`
-* `LSMB_MAIL_SMTPPASS`
-* `LSMB_MAIL_SMTPAUTHMECH`
-
-
-
 # Troubleshooting/Developing
 
 Currently the LedgerSMB installation is in /srv/ledgersmb

docker-compose.yml

@@ -28,12 +28,18 @@ services:
   lsmb:
     depends_on:
       - postgres
-    image: ledgersmb/ledgersmb:1.7
+    image: ledgersmb/ledgersmb:1.6
     networks:
       - internal
       - default
-    ports:
-      - "127.0.0.1:5762:5762"
+    # Uncomment the 'ports' section to map the LedgerSMB container port (5762)
+    #  to the host's port of the same number, thus making LedgerSMB
+    #  available on http://<host-dns-or-ip>:5762/
+    #     SECURITY NOTE: Do this for evaluation purposes only!
+    #       In production, be sure to use SSL/TLS to protect user's passwords
+    #       and other sensitive data
+    # ports:
+    #   - "5762:5762"
     environment:
       # The LSMB_WORKERS environment variable lets you select the number
       # of processes serving HTTP requests. The default number of 2 workers

start.sh

@@ -20,14 +20,30 @@ EOF
   export LSMB_CONFIG_FILE='/tmp/ledgersmb.conf'
 fi
 
-if [ ! -d "/tmp/ledgersmb" ]; then
-  mkdir -p /tmp/ledgersmb
+if [ ! -f "/tmp/ledgersmb" ]; then
+  mkdir /tmp/ledgersmb
 fi
+# Currently unmaintained/untested
+# if [ ! -z ${CREATE_DATABASE+x} ]; then
+#   perl tools/dbsetup.pl --company $CREATE_DATABASE \
+#   --host $POSTGRES_HOST \
+#   --postgres_password "$POSTGRES_PASS"
+#fi
+
+# Needed for modules loaded by cpanm
+export PERL5LIB
+
+for PerlLib in /usr/lib/perl5* /usr/local/lib/perl5*/site_perl/* ; do
+    [[ -d "$PerlLib" ]] && {
+        PERL5LIB="$PerlLib";
+        echo -e "\tmaybe: $PerlLib";
+    }
+done ;
+echo "Selected PERL5LIB=$PERL5LIB";
 
 # start ledgersmb
 # --preload-app allows application initialization to kill the entire
 # starman instance (instead of just the worker, which will immediately
 # get restarted); it also has a positive effect on memory use
 
-exec starman --port 5762 --workers ${LSMB_WORKERS:-5} -I lib -I old/lib \
-        --preload-app bin/ledgersmb-server.psgi
+exec starman --port 5762 --workers ${LSMB_WORKERS:-5} --preload-app bin/ledgersmb-server.psgi