* Automatic Dockerfile update by release process

* Describe environment variables for email config

New environment variables were introduced to enable users to configure
SMTP email forwarding. The variables were listed in the readme but not
described leaving users in the dark regarding the expected content of
the variables.

* Fix bulletpoint formatting

Instead of sub-bullets we present the explanation for email environment
variables as simple text instead.

* Push email env variable explanations to separate line

Dockerfile

@@ -5,7 +5,7 @@ ARG SRCIMAGE=debian:bullseye-slim
 
 FROM  $SRCIMAGE AS builder
 
-ARG LSMB_VERSION="1.9.14"
+ARG LSMB_VERSION="1.10.10"
 ARG LSMB_DL_DIR="Releases"
 ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz"
 
@@ -42,8 +42,16 @@ RUN set -x ; \
 
 FROM  $SRCIMAGE
 LABEL org.opencontainers.image.authors="LedgerSMB project <devel@lists.ledgersmb.org>"
+LABEL org.opencontainers.image.title="LedgerSMB double-entry accounting web-application"
+LABEL org.opencontainers.image.description="LedgerSMB is a full featured double-entry financial accounting and Enterprise\
+ Resource Planning system accessed via a web browser (Perl/JS with a PostgreSQL\
+ backend) which offers 'Accounts Receivable', 'Accounts Payable' and 'General\
+ Ledger' tracking as well as inventory control and fixed assets handling. The\
+ LedgerSMB client can be a web browser or a programmed API call. The goal of\
+ the LedgerSMB project is to bring high quality ERP and accounting capabilities\
+ to Small and Midsize Businesses."
 
-ARG LSMB_VERSION="1.9.14"
+ARG LSMB_VERSION="1.10.10"
 ARG LSMB_DL_DIR="Releases"
 ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz"
 

README.md

@@ -4,16 +4,19 @@ Dockerfile for LedgerSMB Docker image
 
 # Supported tags
 
-- `1.9`, `1.9.x`, `latest` - Latest official release from the 1.9 branch
-- `1.8`, `1.8.x` - Latest official release from the 1.8 branch
-- `1.7`, `1.7.x` - Latest official release from 1.7 branch
-- `1.6`, `1.6.33` - Last 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
+- `1.10`, `1.10.x`, `latest` - Latest official release from the 1.10 branch
+- `1.9`, `1.9.x` - Latest official release from the 1.9 branch
+- `1.8`, `1.8.31` - Last official release from the 1.8 branch (End-of-Life)
+- `1.7`, `1.7.41` - Last official release from the 1.7 branch (End-of-Life)
+- `1.6`, `1.6.33` - Last official release from the 1.6 branch (End-of-Life)
+- `1.5`, `1.5.30` - Last official release from the 1.5 branch (End-of-Life)
+- `1.4`, `1.4.42` - Last official release from the 1.4 branch (End-of-Life)
 - `master` - Master branch from git, unstable
 
 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.
+through the ledgersmb-dev-docker project. See [the development
+container's README](https://github.com/ledgersmb/ledgersmb-dev-docker/blob/master/README.md#getting-started)
+for more information.
 
 # What is LedgerSMB?
 
@@ -48,11 +51,11 @@ or manually with docker only.
 
 ## Docker-Compose: Installation and start
 
-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:
+This image provides a file named `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
@@ -172,13 +175,30 @@ 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`
+* `LSMB_MAIL_SMTPHOST` \
+  The host name/IP-address of the SMTP server that will forward mail from
+  LedgerSMB to the outside world.
+* `LSMB_MAIL_SMTPPORT` \
+  The port that the SMTP server in `LSMB_MAIL_SMTPHOST` listens to.
+* `LSMB_MAIL_SMTPTLS` \
+  Can be one of `no` (default), `yes` or `raw`. `yes` indicates to use
+  STARTTLS over a regular SMTP connection; `raw`' indicates an SMTP connection
+  should be established over a TLS connection (a.k.a. smtps).
+* `LSMB_MAIL_SMTPSENDER_HOSTNAME` (optional) \
+  When set, used to identify the host when connecting to an SMTP server. When
+  not set, the host is queried for its host name.
+* `LSMB_MAIL_SMTPUSER` \
+  Username to authenticate to the SMTP host in `LSMB_MAIL_SMTPHOST`.
+* `LSMB_MAIL_SMTPPASS` \
+  Password to authenticate to the SMTP host in `LSMB_MAIL_SMTPHOST` with the
+  user in `LSMB_MAIL_SMTPUSER`.
+* `LSMB_MAIL_SMTPAUTHMECH` \
+  A space separated list of SASL mechanisms to be used for authentication of
+  the smtp connection with the SMTP server. Available mechanisms depend on
+  your installed environment, but the following mechanisms should be available
+  in all of them: `PLAIN` `LOGIN` `CRAM_MD5` & `DIGEST_MD5`. **Note that**
+  `PLAIN` or `LOGIN` send passwords in plain text over the wire to the SMTP
+  server; only use these methods in combination with TLS encryption.
 
 # Advanced setup
 

docker-compose-reverseproxy.yml

@@ -17,12 +17,17 @@
 version: "3.2"
 services:
   proxy:
+    depends_on:
+      - lsmb
     image: nginx:1-alpine
     volumes:
       - "lsmbdata:/srv/ledgersmb"
       - "./nginx.conf:/etc/nginx/nginx.conf"
     ports:
       - "8080:8080"
+    # Comment the line below to stop the container from restarting on boot
+    # unless it was manually stopped
+    restart: unless-stopped
   lsmb:
     volumes:
       - "lsmbdata:/srv/ledgersmb"

docker-compose.yml

@@ -25,10 +25,13 @@ services:
       - internal
     volumes:
       - "pgdata:/var/lib/postgresql/data"
+    # Comment the line below to stop the container from restarting on boot
+    # unless it was manually stopped
+    restart: unless-stopped
   lsmb:
     depends_on:
       - postgres
-    image: ghcr.io/ledgersmb/ledgersmb:1.9
+    image: ghcr.io/ledgersmb/ledgersmb:1.10
     networks:
       - internal
       - default
@@ -67,6 +70,9 @@ services:
       # hosted in a separate container, this setting needs to be adjusted.
       #
       # PROXY_IP: 172.17.0.1/12
+    # Comment the line below to stop the container from restarting on boot
+    # unless it was manually stopped
+    restart: unless-stopped
 
 # having the dbdata volume is required to persist our
 # data between PostgreSQL container updates; without