* Automatic Dockerfile update by release process

Meaning there's no need to explicitly mention it in the
package installation lines; it'll be automatically mapped.

.github/workflows/images-cleanup.yml

@@ -0,0 +1,18 @@
+name: Docker Image cleanup
+
+on:
+  push:
+  workflow_dispatch:
+  schedule:
+    # Schedule for five minutes after the hour, every Friday
+    - cron: '10 3 * * 5'
+
+jobs:
+  cleanup:
+    if: github.repository_owner == 'ledgersmb'
+    runs-on: ubuntu-latest
+    steps:
+    - name: ghcr.io cleanup action
+      uses: dataaxiom/ghcr-cleanup-action@v1
+      with:
+        packages: ledgersmb

.github/workflows/no-response.yml

@@ -0,0 +1,26 @@
+name: No Response
+
+# Both `issue_comment` and `scheduled` event types are required for this Action
+# to work properly.
+on:
+  issue_comment:
+    types: [created]
+  schedule:
+    # Schedule for five minutes after the hour, every hour
+    - cron: '5 3 * * *'
+
+jobs:
+  noResponse:
+    if: github.repository_owner == 'ledgersmb'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v9
+        with:
+          days-before-issue-stale: -1
+          days-before-pr-stale: -1
+          stale-issue-label: waiting-for-user
+          # Number of days of inactivity before an Issue is closed for lack of response
+          days-before-close: 90
+          # Label requiring a response
+          close-issue-message: >
+            Closing: more than 90 days without user response. Feel free to reopen with your comments.

Dockerfile

@@ -1,69 +1,138 @@
-FROM        debian:jessie
-MAINTAINER  Freelock john@freelock.com
-
 # Build time variables
-ENV LSMB_VERSION 1.4
+
+ARG SRCIMAGE=debian:bookworm-slim
 
 
-# Install PHP5 and modules along with composer binary
+FROM  $SRCIMAGE AS builder
-RUN DEBIAN_FRONTENT=noninteractive && \
-  apt-get update && apt-get -y install \
-  git \
-  libdatetime-perl libdbi-perl libdbd-pg-perl \
-  libcgi-simple-perl libtemplate-perl libmime-lite-perl \
-  liblocale-maketext-lexicon-perl libtest-exception-perl \
-  libtest-trap-perl liblog-log4perl-perl libmath-bigint-gmp-perl \
-  libfile-mimeinfo-perl libtemplate-plugin-number-format-perl \
-  libdatetime-format-strptime-perl libconfig-general-perl \
-  libdatetime-format-strptime-perl libio-stringy-perl libmoose-perl \
-  libconfig-inifiles-perl libnamespace-autoclean-perl \
-  libcarp-always-perl libjson-perl \
-  libtemplate-plugin-latex-perl texlive-latex-recommended \
-  libnet-tclink-perl \
-  libxml-twig-perl \
-  starman \
-  postgresql-client-9.4 \
-  ssmtp
 
-# Install LedgerSMB
+ARG LSMB_VERSION="1.12.7"
+ARG LSMB_DL_DIR="Releases"
+ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz"
+
+
+RUN set -x ; \
+  DEBIAN_FRONTEND="noninteractive" apt-get -q -y update && \
+  DEBIAN_FRONTEND="noninteractive" apt-get -q -y dist-upgrade && \
+  DEBIAN_FRONTEND="noninteractive" apt-get -q -y install dh-make-perl libmodule-cpanfile-perl git wget && \
+  apt-file update
+
+RUN set -x ; \
+  wget --quiet -O /tmp/ledgersmb-$LSMB_VERSION.tar.gz "$ARTIFACT_LOCATION" && \
+  tar -xzf /tmp/ledgersmb-$LSMB_VERSION.tar.gz --directory /srv && \
+  rm -f /tmp/ledgersmb-$LSMB_VERSION.tar.gz && \
+  cd /srv/ledgersmb && \
+  ( ( for lib in $( cpanfile-dump --with-all-features --recommends --no-configure --no-build --no-test ) ; \
+    do \
+      if dh-make-perl locate "$lib" 2>/dev/null ; \
+      then  \
+        : \
+      else \
+        echo no : $lib ; \
+      fi ; \
+    done ) | grep -v dh-make-perl | grep -v 'not found' | grep -vi 'is in Perl ' | cut -d' ' -f4 | sort | uniq | tee /srv/derived-deps ) && \
+  cat /srv/derived-deps
+
+
+#
+#
+#  The real image build starts here
+#
+#
+
+
+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.12.7"
+ARG LSMB_DL_DIR="Releases"
+ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz"
+
+
+### PACKAGE REQUIREMENTS RATIONALE
+#
+# postgresql-client(from apt.postgresql.org): reduces chances running a newer server than this client
+# fonts-liberation: installed for compatibility with templates from 1.8 and earlier
+
+COPY --from=builder /srv/derived-deps /tmp/derived-deps
+
+RUN set -x ; \
+  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/ && \
+  mkdir -p /usr/share/man/man3/ && \
+  mkdir -p /usr/share/man/man4/ && \
+  mkdir -p /usr/share/man/man5/ && \
+  mkdir -p /usr/share/man/man6/ && \
+  mkdir -p /usr/share/man/man7/ && \
+  mkdir -p /usr/share/man/man8/ && \
+  DEBIAN_FRONTEND="noninteractive" apt-get -q -y update && \
+  DEBIAN_FRONTEND="noninteractive" apt-get -q -y dist-upgrade && \
+  DEBIAN_FRONTEND="noninteractive" apt-get -q -y install \
+    wget ca-certificates gnupg iproute2 \
+    $( cat /tmp/derived-deps ) \
+    texlive-plain-generic texlive-latex-recommended texlive-fonts-recommended \
+    texlive-xetex fonts-liberation \
+    lsb-release postgresql-common && \
+  /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y && \
+  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 "$ARTIFACT_LOCATION" && \
+  tar -xzf /tmp/ledgersmb-$LSMB_VERSION.tar.gz --directory /srv && \
+  rm -f /tmp/ledgersmb-$LSMB_VERSION.tar.gz && \
+  cpanm --metacpan --notest \
+    --with-feature=starman \
+    --with-feature=latex-pdf-ps \
+    --with-feature=openoffice \
+    --installdeps /srv/ledgersmb/ && \
+  DEBIAN_FRONTEND="noninteractive" apt-get purge -q -y git cpanminus make gcc libperl-dev && \
+  DEBIAN_FRONTEND="noninteractive" apt-get autoremove -q -y && \
+  DEBIAN_FRONTEND="noninteractive" apt-get clean -q && \
+  rm -rf ~/.cpanm/ /var/lib/apt/lists/* /usr/share/man/*
 
-RUN cd /srv && \
-  git clone https://github.com/ledgersmb/LedgerSMB.git ledgersmb
 
 WORKDIR /srv/ledgersmb
 
-RUN git checkout $LSMB_VERSION
+# master requirements
-
-#RUN sed -i \
-#  -e "s/short_open_tag = Off/short_open_tag = On/g" \
-#  -e "s/post_max_size = 8M/post_max_size = 20M/g" \
-#  -e "s!^;sendmail_path =.*\$!sendmail_path = /usr/sbin/ssmtp -t!g" \
-#  /etc/php5/fpm/php.ini && \
 
 # Configure outgoing mail to use host, other run time variable defaults
 
-## sSMTP
+## MAIL
-ENV SSMTP_ROOT ar@example.com
+# '__CONTAINER_GATEWAY__' is a magic value which will be substituted
-ENV SSMTP_MAILHUB 172.17.42.1
+# with the actual gateway IP address
-ENV SSMTP_HOSTNAME 172.17.42.1
+ENV LSMB_MAIL_SMTPHOST=__CONTAINER_GATEWAY__
-#ENV SSMTP_USE_STARTTLS
+#ENV LSMB_MAIL_SMTPPORT=25
-#ENV SSMTP_AUTH_USER
+#ENV LSMB_MAIL_SMTPSENDER_HOSTNAME=(container hostname)
-#ENV SSMTP_AUTH_PASS
+#ENV LSMB_MAIL_SMTPTLS=
-ENV SSMTP_FROMLINE_OVERRIDE YES
+#ENV LSMB_MAIL_SMTPUSER=
-#ENV SSMTP_AUTH_METHOD
+#ENV LSMB_MAIL_SMTPPASS=
+#ENV LSMB_MAIL_SMTPAUTHMECH=
 
-ENV POSTGRES_HOST postgres
+## DATABASE
+ENV POSTGRES_HOST=postgres
+ENV POSTGRES_PORT=5432
+ENV DEFAULT_DB=lsmb
 
-COPY start.sh /usr/bin/start.sh
+COPY start.sh /usr/local/bin/start.sh
-COPY update_ssmtp.sh /usr/bin/update_ssmtp.sh
 
+RUN chmod +x /usr/local/bin/start.sh && \
+  mkdir -p /var/www && \
+  mkdir -p /srv/ledgersmb/local/conf && \
+  chown -R www-data /srv/ledgersmb/local
 
-RUN chown www-data /etc/ssmtp /etc/ssmtp/ssmtp.conf && \
+# Work around an aufs bug related to directory permissions:
-  chmod +x /usr/bin/update_ssmtp.sh /usr/bin/start.sh && \
+RUN mkdir -p /tmp && chmod 1777 /tmp
-  mkdir -p /var/www
 
 # Internal Port Expose
-EXPOSE 5000
+EXPOSE 5762
-#USER www-data
 
+USER www-data
 CMD ["start.sh"]

README.md

@@ -1,107 +1,327 @@
-# ledgersmb-docker - EXPERIMENTAL
+# ledgersmb-docker
+
 Dockerfile for LedgerSMB Docker image
 
-This is a work in progress to make a docker image for running LedgerSMB. It should not be relied upon for production use!
+## Content
 
-# Supported tags and respective `Dockerfile` links
+ 1. [Supported tags](#supported-tags)
+ 2. [What is LedgerSMB](#what-is-ledgersmb)
+ 3. [How to use this image](#how-to-use-this-image)
+ 4. [Set up LedgerSMB](#set-up-ledgersmb)
+ 5. [Updating the LedgerSMB container](#updating-the-ledgersmb-container)
+ 6. [Environment Variables](#environment-variables)
+ 7. [Advanced setup](#advanced-setup)
+ 8. [Troubleshooting](#troubleshootingdeveloping)
+ 9. [User feedback](#user-feedback)
 
--	`1.5`, `dev-master` - Master branch, unstable
+# Supported tags
-- `1.4`, `latest` - Tip of git 1.4 branch
-- `1.4.12` - Latest stable release (not yet built)
-- `1.3.45` - Last 1.3.x release (not yet built)
 
+- `1.12`, `1.12.x`, `latest` - Latest official release from the 1.12 branch
+- `1.11`, `1.11.x` - Latest official release from the 1.11 branch
+- `1.10`, `1.10.38` - Last official release from the 1.10 branch (End-of-Life)
+- `1.9`, `1.9.30` - Last official release from the 1.9 branch (End-of-Life)
+- `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 [the development
+container's README](https://github.com/ledgersmb/ledgersmb-dev-docker/blob/master/README.md#getting-started)
+for more information.
 
 # What is LedgerSMB?
-The LedgerSMB project's priority is to provide an extremely capable yet user-friendly accounting and ERP solution to small to mid-size businesses in all locales where there is interest in using the software. The focus on small to mid-size businesses offers an opportunity to provide a positive user experience in ways which are not present in larger organizations. LedgerSMB ought to strive to be both the ideal SMB accounting/ERP package and also a solution that a start-up will never outgrow. The goals mentioned above will help us provide this ideal solution by allowing us to focus both on technical architecture and on user experience.
+
+LedgerSMB is a user-friendly accounting and ERP solution for small to
+mid-size businesses. It comes with support for many languages and support
+for different locales.
+
+The project aims to be the solution a start-up never outgrows.
 
 
 # How is this image designed to be used?
 
-This Docker image is built to provide a self-contained LedgerSMB instance. To be functional, you need to connect it to a running Postgres installation. The official Postgres container will work as is, if you link it to the LedgerSMB instance at startup, or you can provide environment variables to an appropriate Postgres server.
+This image is designed to be used in conjunction with a running PostgreSQL
+instance (such as may be provided through a separate image).
 
-LedgerSMB provides an http interface built on Starman out of the box, listening on port 5000. We do not recommend exposing this port, because we strongly recommend encrypting all connections using SSL/TLS. For production use, we recommend running a web server configured with SSL, such as Nginx or Apache, and proxying connections to LedgerSMB.
+This image exposes port 5762 running a Starman HTTP application server. We
+do recommend not exposing this port publicly, because
 
-The other services you will need to put this in production are an SMTP gateway (set environment variables for SSMTP at container startup) and optionally a local print server (e.g. CUPS) installation. The print service is not currently supported in this Docker image, but pull requests are welcomed ;-)
+1. The Starman author recommends not exposing it
+2. We strongly recommend TLS encryption of all application traffic
 
+While the exposed port can be used for quick evaluation, it's recommended
+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
 
-## Start a postgres instance
+This image can be installed either automatically with the Docker compose file
+or manually with docker only.
 
-	docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d postgres
+## Docker-Compose: Installation and start
 
-This image includes `EXPOSE 5432` (the postgres port), so standard container linking will make it automatically available to the linked containers. The default `postgres` user and database are created in the entrypoint with `initdb`.
+This repository 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:
 
-> The postgres database is a default database meant for use by users, utilities and third party applications.  
+```plain
-> [postgresql.org/docs](http://www.postgresql.org/docs/9.3/interactive/app-initdb.html)
+ $ docker-compose pull
+ $ docker-compose up -d
+```
 
-## Start LedgerSMB
+Or use the following to set a different password and/or parallel processing
+capacity (so called 'workers'):
 
-	docker run --name myledger --link some-postgres:postgres -d ledgersmb/ledgersmb
+```plain
+ $ docker-compose pull
+ $ POSTGRES_PASSWORD=def \
+   LSMB_WORKERS=10 \
+   docker-compose up -d
+```
 
-## Set up LedgerSMB
+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. Your LedgerSMB installation should now be accessible through
+[http://localhost:5762/](http://localhost:5762/).
 
-Visit http://myledger:5000/setup.pl (you can forward port 5000 to the host machine, or lookup the IP address for the "myledger" container if running on localhost)
+The default number of workers is 5. The default database username and password
+are:
 
-Log in with the "postgres" user and the password you set when starting up the Postgres container.
+```plain
+   username: postgres
+   password: abc
+```
 
-Once you have completed the setup, you have a fully functional LedgerSMB instance running!
+From here, follow the steps as detailed in the instructions for
+[preparing for first use](https://ledgersmb.org/content/preparing-ledgersmb-19-first-use).
 
-## Updating the LedgerSMB container
+## Manual installation
 
-No persistant data is stored in the LedgerSMB container. All LedgerSMB data is stored in Postgres, so you can stop/destroy/run a new LedgerSMB container, and as long as you link it to the Postgres database, you should be able to pick up where you left off.
+This section assumes availability of a PostgreSQL server to attach to the
+LedgerSMB image as the database server.
 
-## Environment Variables
+### Start LedgerSMB
 
-The LedgerSMB image uses several environment variables which are easy to miss. While none of the variables are required, they may significantly aid you in using the image.
+```plain
+ $ docker run -d -p 5762:5762 --name myledger \
+              -e POSTGRES_HOST=<ip/hostname> ledgersmb/ledgersmb:latest
+```
 
-### `POSTGRES_HOST` = 'postgres'
+This command maps port 5762 of your container to port 5762 in your host. The
+web application inside the container should now be accessible through
+http://localhost:5762/setup.pl and http://localhost:5762/login.pl.
 
-This environment variable is used to specify the hostname of the Postgres server. The default is "postgres", which will find the container linked in.
+Below are more variables which determine container configuration,
+like `POSTGRES_HOST` above.
 
-If you set this to another hostname, LedgerSMB will attempt to connect to that hostname instead.
+# Set up LedgerSMB
 
-### `SSMTP_ROOT` `SSMTP_MAILHUB` `SSMTP_HOSTNAME` `SSMTP_USE_STARTTLS` `SSMTP_AUTH_USER` `SSMTP_AUTH_PASS` `SSMTP_METHOD` `SSMTP_FROMLINE_OVERRIDE`
+ * Visit http://myledger:5762/setup.pl.
+ * Log in with the "postgres" user and the password `abc` as given above -
+   or with the credentials of your own database server in case of a manual
+   setup - and provide the name of a company (= database name) you want to
+   create.
+ * Go over the steps presented in the browser
 
-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 those two set.
+Once you have completed the setup steps, you have a fully functional
+LedgerSMB instance running!
 
-Use the other environment variables to relay mail through another host.
+Visit http://localhost:5762/login.pl to log in and get started.
 
-### `CREATE_DATABASE` `POSTGRES_PASS`
+# Updating the LedgerSMB container
 
-If `CREATE_DATABASE` is set, the tools/dbsetup.pl is called with the database name, and the postgres host and password. Currently this is failing with 'Can't locate object method "process_roles" via package "LedgerSMB::Database" at tools/dbsetup.pl line 203.'
+No persistant data is stored in the LedgerSMB container.
 
-Once this is working, this will provision a new database in the existing server. After the first run, we recommend stopping/removing the LedgerSMB container and starting a new one without these variables -- the previous database should remain present.
+All LedgerSMB data is stored in PostgreSQL, so you can stop/destroy/run a
+new LedgerSMB container as often as you want.
+
+In case of the Docker Compose setup, all PostgreSQL data is stored on the
+Docker volume with the name ending in `_pgdata`. This volume is not destroyed
+when updating the containers; only explicit removal destroys the data.
+
+# Environment Variables
+
+The LedgerSMB image uses several environment variables. They are all optional.
+
+
+## `POSTGRES_HOST`
+
+Default: postgres
+
+Specifies the hostname of the PostgreSQL server to connect to. If you use
+a PostgreSQL image, set it to the name of that image.
+
+## `POSTGRES_PORT`
+
+Default: 5432
+
+Port on which the PostgreSQL server is running.
+
+## `DEFAULT_DB`
+
+Default: lsmb
+
+Set this if you want to automatically log in to a particular LedgerSMB database
+without needing to enter the name of that database on the login.pl login screen.
+
+## `LSMB_WORKERS`
+
+Default: 5
+
+Set this if you want to run in a memory-constrained environment. E.g. set it to
+2 when running in a 1 GB memory setup. Please do note that this may adversely
+affect the performance experience of users.
+
+## Mail configuration
+
+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` \
+  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
+
+## Changing configuration
+
+The configuration file is stored in /srv/ledgersmb/local/conf/. By mounting
+that directory using a bind-mount to a location outside the container,
+configuration can be changed between container starts:
+
+```plain
+ $ docker run -d -p 5762:5762 --name myledger \
+     --mount 'type=bind,src=/home/ledgersmb/conf,dst=/srv/ledgersmb/local/conf \
+     -e POSTGRES_HOST=<ip/hostname> ledgersmb/ledgersmb:latest
+```
+
+## Overriding or adding configuration
+
+By pre-creating a configuration file in the mounted configuration directory,
+the standard configuration generation process in the container can be overruled:
+
+```plain
+ $ cat <<EOF > /home/ledgersmb/conf/ledgersmb.yaml
+   ... YOUR CONFIG HERE ...
+ EOF
+ $ docker run -d -p 5762:5762 --name myledger \
+     --mount 'type=bind,src=/home/ledgersmb/conf,dst=/srv/ledgersmb/local/conf \
+     -e POSTGRES_HOST=<ip/hostname> ledgersmb/ledgersmb:latest
+```
+
+If you do not want to completely overrule the configuration generated, but instead
+supplement the configuration, you can put incremental configuration snippets in
+files named `ledgersmb.1XX.yaml` in the same folder. E.g.:
+
+```plain
+ $ cat <<EOF > /home/ledgersmb/conf/ledgersmb.100.yaml
+ logging:
+   file: ledgersmb.logging
+ EOF
+```
+
+[Documentation with respect to the available configuration
+keys](https://github.com/ledgersmb/LedgerSMB/blob/master/doc/conf/ledgersmb.yaml)
+is available in the LedgerSMB repository.
+
+## Docker Compose with reverse proxy
+
+The `docker-compose-reverseproxy.yml` file shows a docker-compose setup
+which adds an Nginx reverse proxy configuration on top of the base
+`docker-compose.yml` configuration file. If the content of this repository
+is cloned into the current directory (`git clone https://github.com/ledgersmb/ledgersmb-docker.git ; cd ledgersmb-docker`), it can be used as:
+
+```plain
+ $ docker-compose \
+    -f docker-compose.yml \
+    -f docker-compose-reverseproxy.yml \
+       up -d
+```
+
+This setup can be used in combination with an image which runs the
+Certbot certificate renewal process *and* Nginx to do TLS termination. The
+default reverse proxy is mostly an example; it publishes on
+[http://localhost:8080/](http://localhost:8080/).
+
+An example of such an image can be found at
+[https://github.com/jonasalfredsson/docker-nginx-certbot](https://github.com/jonasalfredsson/docker-nginx-certbot),
+which is published on Docker Hub as
+[jonasal/nginx-certbot](https://hub.docker.com/r/jonasal/nginx-certbot).
+
+**Upgrade note** When upgrading this setup, please remove the volume ending
+in `_lsmbdata` before starting the upgraded containers. Without that, the
+webcontent won't be upgraded! E.g.:
+
+```plain
+  $ docker-compose \
+      -f docker-compose.yml \
+      -f docker-compose-reverseproxy.yml \
+        rm -s -f -v && \
+    docker volume rm ledgersmb-docker_lsmbdata && \
+    docker-compose \
+      -f docker-compose.yml \
+      -f docker-compose-reverseproxy.yml \
+        pull && \
+    docker-compose \
+      -f docker-compose.yml \
+      -f docker-compose-reverseproxy.yml \
+        up -d
+```
 
 # Troubleshooting/Developing
 
-You can connect to a running container using:
+Currently the LedgerSMB installation is in /srv/ledgersmb
+and the startup & config script is /usr/bin/start.sh.
 
-> docker exec -ti myledger /bin/bash
-
-... this will give you a shell inside the container where you can inspect/troubleshoot the installation.
-
-Currently the LedgerSMB installation is in /srv/ledgersmb, and the startup/config script is /usr/bin/start.sh.
-
-
-# Supported Docker versions
-
-This image is officially supported on Docker version 1.7.0.
-
-Support for older versions is provided on a best-effort basis.
 
 # User Feedback
 
-## Documentation
-
-This is a brand new effort, and we will be adding documentation to the http://ledgersmb.org site when we get a chance.
-
 ## Issues
 
-If you have any problems with or questions about this image or LedgerSMB, please contact us on the [mailing list](http://ledgersmb.org/topic/support/mailing-lists-rss-and-nntp-feeds) or through a [GitHub issue](https://github.com/ledgersmb/ledgersmb-docker/issues).
+If you have any problems with or questions about this image or LedgerSMB,
+please contact us on the [mailing list](http://ledgersmb.org/topic/support/mailing-lists-rss-and-nntp-feeds)
+or through a [GitHub issue](https://github.com/ledgersmb/ledgersmb-docker/issues).
+
+You can also reach some of the official LedgerSMB maintainers via the
+[Matrix](https://matrix.org) room in [#ledgersmb:matrix.org](https://matrix.to/#/#ledgersmb:matrix.org).
+The [Element](https://app.element.io/#/room/#ledgersmb:matrix.org) Matrix client is highly recommended.
 
-You can also reach some of the official LedgerSMB maintainers via the `#ledgersmb` IRC channel on [Freenode](https://freenode.net).
 
 ## Contributing
 
-You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+You are invited to contribute new features, fixes, or updates, large or small;
+we are always thrilled to receive pull requests, and do our best to process
+them as fast as we can.

docker-compose-reverseproxy.yml

@@ -0,0 +1,36 @@
+# Use this docker-compose file as:
+#
+#  docker-compose -f docker-compose.yml -f docker-compose-reverseproxy.yml up -d
+#
+#
+# This command creates one
+# compose 'project' consisting of three containers
+#
+#  1. The PostgreSQL data  container
+#  2. The LedgerSMB application container
+#  3. The Nginx reverse proxy container
+#
+# In addition to publishing LedgerSMB on port 5762 on localhost,
+# this project also publishes Nginx's reverse proxied content on
+# port 8080 on localhost
+
+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"
+
+volumes:
+  lsmbdata:

docker-compose.yml

@@ -0,0 +1,100 @@
+# This docker-compose file creates one
+# compose 'project' consisting of two containers
+#
+#  1. The PostgreSQL data  container
+#  2. The LedgerSMB application container
+#
+# LedgerSMB persists all its data in the database,
+# so no special care needs to be taken on
+# container upgrades.  With PostgreSQL, data is
+# persisted across upgrades by the use of a
+# special 'dbdata' volume
+
+version: "3.2"
+services:
+  # Note that the container needs to be named "postgres" here,
+  # because that allows us to use the default hostname ("postgres")
+  # from the LedgerSMB configuration
+  postgres:
+    image: postgres:15-alpine
+    environment:
+      # Replace the password below for a secure setup
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-abc}
+      PGDATA: /var/lib/postgresql/data/pgdata
+    networks:
+      - 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.12
+      # In order to store the configuration outside the image, allowing it to
+      # be edited between container restarts, uncomment the section below and
+      # change the 'source' to the directory where you want the configuration
+      # to be stored.
+    # volumes:
+    #   # Override all configuration:
+    #   - type: bind
+    #     source: /home/ledgersmb/conf
+    #     target: /srv/ledgersmb/local/conf
+    #   # Add a snippet of configuration:
+    #   - type: bind
+    #     source: /home/ledgersmb/conf/ledgersmb.100.yaml
+    #     target: /srv/ledgersmb/local/conf/ledgersmb.100.yaml
+    networks:
+      - internal
+      - default
+    # Comment the 'ports' section to disable mapping the LedgerSMB container port (5762)
+    #  to the host's port of the same number. Mapping "5762:5762" makes LedgerSMB
+    #  available on http://<host-dns-or-ip>:5762/
+    #     SECURITY NOTE:  Leave this uncommented for evaluation purposes only!
+    #       In production, be sure to use SSL/TLS (such as by reverse proxying) 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
+      # is geared toward limited-memory situations (1 GB). In order to
+      # improve the performance experience, increase memory and the
+      # number of workers
+      #
+      LSMB_WORKERS: ${LSMB_WORKERS:-5}
+      #
+      #
+
+      # LSMB_MAIL_SMTPHOST:
+      # LSMB_MAIL_SMTPPORT:
+      # LSMB_MAIL_SMTPTLS:
+      # LSMB_MAIL_SMTPSENDER_HOSTNAME:
+      # LSMB_MAIL_SMTPUSER:
+      # LSMB_MAIL_SMTPPASS:
+      # LSMB_MAIL_SMTPAUTHMECH:
+      #
+      #
+      # The PROXY_IP environment variable lets you set the IP address
+      # (range) of the reverse proxy used for TLS termination, which forwards
+      # its requests to this container. When this reverse proxy runs on the
+      # Docker host, the default below applies. In case the reverse proxy is
+      # 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
+# that, the data is contained in the same volume as
+# the rest of the image and on update/upgrade, the
+# data will be lost.
+volumes:
+  pgdata:
+
+
+networks:
+  internal:

nginx.conf

@@ -0,0 +1,81 @@
+# This is a full (minimal) nginx configuration file
+
+error_log /dev/stderr info;
+pid /tmp/nginx.pid;
+worker_processes 1;
+
+events {
+   worker_connections 1024;
+}
+
+http {
+   client_body_temp_path /tmp/client_body;
+   proxy_temp_path /tmp/proxy_temp;
+   fastcgi_temp_path /tmp/fastcgi_temp;
+   scgi_temp_path /tmp/scgi_temp;
+   uwsgi_temp_path /tmp/uwsgi_temp;
+
+   sendfile on;
+   tcp_nopush on;
+   tcp_nodelay on;
+   keepalive_timeout 65;
+   types_hash_max_size 2048;
+   include /etc/nginx/mime.types;
+   default_type application/octet-stream;
+
+   access_log /dev/stdout;
+   error_log /dev/stderr info;
+
+   gzip off;
+   gzip_static on;
+
+   server {
+      listen 8080 default_server;
+      listen [::]:8080 default_server ipv6only=on;
+
+      root /srv/ledgersmb/UI;
+
+      access_log /dev/stdout;
+      error_log /dev/stderr info;
+
+      # Don't log status polls
+      location /nginx_status {
+               stub_status on;
+               access_log off;
+               allow 127.0.0.1;
+               allow ::1;
+               deny all;
+      }
+
+      # Configuration files don't exist
+      location ^~ \.conf$ {
+         return 404;
+      }
+
+      # 'Hidden' files don't exist
+      location ~ /\. {
+         return 404;
+      }
+
+      location = / {
+         return 301 /login.pl;
+      }
+
+      # JS & CSS
+      location ~* \.(js|css)$ {
+         add_header Pragma "public";
+         add_header Cache-Control "public, must-revalidate, proxy-revalidate"; # Production
+         expires     7d; # Indicate that the resource can be cached for 1 week # Production
+         try_files $uri =404;
+      }
+
+      location / {
+         proxy_set_header        Host $host;
+         proxy_set_header        X-Real-IP $remote_addr;
+         proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
+         proxy_set_header        X-Forwarded-Proto $scheme;
+         proxy_read_timeout      300;
+         proxy_pass              http://lsmb:5762;
+      }
+   }
+}

start.sh

@@ -1,27 +1,175 @@
 #!/bin/bash
 
-if [[ -e /tmp/smtpconfig ]]; then
+cd /srv/ledgersmb
-  echo "smtp configured."
+[[ -d ./local/conf/ ]] || mkdir ./local/conf/
-else
+if [[ -n "$SSMTP_ROOT" ]]; then
-  update_ssmtp.sh
+    echo "\$SSMTP_ROOT set; parameter is deprecated and will be ignored"
-  touch /tmp/smtpconfig
+    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
-if [[ ! -f ledgersmb.conf ]]; then
+    echo "!!! DEPRECATED \$SSMTP_* PARAMETERS WILL BE REMOVED in the 1.9 image!!!"
-  cp ledgersmb.conf.default ledgersmb.conf
-  sed -i \
-    -e "s/\(cache_templates = \).*\$/cache_templates = 1/g" \
-    -e "s/\(host = \).*\$/\1$POSTGRES_HOST/g" \
-    -e "s%\(sendmail   = \).*%\1/usr/bin/ssmtp%g" \
-    /srv/ledgersmb/ledgersmb.conf
 fi
 
-if [ ! -z ${CREATE_DATABASE+x} ]; then
+if [[ ! -f ./local/conf/ledgersmb.yaml ]]; then
-  perl tools/dbsetup.pl --company $CREATE_DATABASE \
+  if [[ "x$LSMB_MAIL_SMTPTLS" == "xyes" ]]; then
-  --host $POSTGRES_HOST \
+     tls_mode=starttls
-  --postgres_password "$POSTGRES_PASS"
+  elif [[ "x$LSMB_MAIL_SMTPTLS" == "xraw" ]]; then
+     tls_mode=ssl
+  else
+     tls_mode=none
+  fi
+  cat <<EOF >./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 <<EOF >./local/conf/ledgersmb.000.yaml
+mail:
+  transport:
+    host: $LSMB_MAIL_SMTPHOST
+EOF
+  fi
+
+  if [[ -n "$LSMB_MAIL_SMTPPORT" ]]
+  then
+      cat <<EOF >./local/conf/ledgersmb.001.yaml
+mail:
+  transport:
+    port: $LSMB_MAIL_SMTPPORT
+EOF
+  fi
+
+  if [[ -n "$LSMB_MAIL_SMTPSENDER_HOSTNAME" ]]
+  then
+      cat <<EOF >./local/conf/ledgersmb.002.yaml
+mail:
+  transport:
+    helo: $LSMB_MAIL_SMTPSENDER_HOSTNAME
+EOF
+  fi
+
+  if [[ -n "$LSMB_MAIL_SMTPUSER" ]]
+  then
+      cat <<EOF >./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
-exec starman tools/starman.psgi
+# --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'
+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

update_ssmtp.sh

@@ -1,12 +0,0 @@
-#!/bin/bash
-
-sed -i \
-    -e "s/\(root=\).*\$/\1$SSMTP_ROOT/g" \
-    -e "s/\(mailhub=\).*\$/\1$SSMTP_MAILHUB/g" \
-    -e "s/\(hostname=\).*\$/\1$SSMTP_HOSTNAME/g" \
-    /etc/ssmtp/ssmtp.conf
-[ -z "$SSMTP_USE_STARTTLS" ] || echo "UseSTARTTLS=$SSMTP_USE_STARTTLS" >> /etc/ssmtp/ssmtp.conf
-[ -z "$SSMTP_AUTH_USER" ] || echo "AuthUser=$SSMTP_AUTH_USER" >> /etc/ssmtp/ssmtp.conf
-[ -z "$SSMTP_AUTH_PASS" ] || echo "AuthPass=$SSMTP_AUTH_PASS" >> /etc/ssmtp/ssmtp.conf
-[ -z "$SSMTP_AUTH_METHOD" ] || echo "AuthMethod=$SSMTP_AUTH_METHOD" >> /etc/ssmtp/ssmtp.conf
-[ -z "$SSMTP_FROMLINE_OVERRIDE" ] || echo "FromLineOverride=$SSMTP_FROMLINE_OVERRIDE" >> /etc/ssmtp/ssmtp.conf