* Automatic Dockerfile update by release process

Note that we found in the LedgerSMB Matrix chat channel that users
need more straight forward ways to quickly evaluate our proposition
which they are able to offer if we skip the TLS requirement

Also note that the TLS requirement requires a domain, which some
might not have at the stage where the system is only being evaluated.

Dockerfile

@@ -2,7 +2,7 @@ FROM        debian:jessie-slim
 MAINTAINER  Freelock john@freelock.com
 
 # Build time variables
-ENV LSMB_VERSION 1.5.17
+ENV LSMB_VERSION 1.5.24
 
 
 # Install Perl, Tex, Starman, psql client, and all dependencies

README.md

@@ -35,6 +35,19 @@ 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.
 
+# Quickstart
+
+The quickest way to get this image up and running is by using the
+`docker-compose` file available through the GitHub repository at:
+
+  https://github.com/ledgersmb/ledgersmb-docker/blob/1.5/docker-compose.yml
+
+which sets up both this image and a supporting database image for
+production purposes (i.e. with persistent (database) data, with the
+exception of one thing: setting up an Nginx or Apache reverse proxy
+with TLS 1.2 support -- a requirement if you want to access your
+installation over any type of network.
+
 # How to use this image
 
 ## Start a postgres instance
@@ -116,8 +129,18 @@ 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
 
+The docker image uses `ssmtp` to send mail. 
+
 * `SSMTP_ROOT` (config: `Root`)
 * `SSMTP_MAILHUB` (config: `Mailhub`)
 * `SSMTP_HOSTNAME` (config: `Hostname`)

docker-compose.yml

@@ -0,0 +1,72 @@
+# 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:9.6-alpine
+    environment:
+      # Replace the password below for a secure setup
+      POSTGRES_PASSWORD: abc
+      PGDATA: /var/lib/postgresql/data/pgdata
+    networks:
+      - internal
+    volumes:
+      - "pgdata:/var/lib/postgresql/data"
+  lsmb:
+    depends_on:
+      - postgres
+    image: ledgersmb/ledgersmb:1.5
+    networks:
+      - internal
+      - default
+    # 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
+      # is geared toward limited-memory situations (1 GB). In order to
+      # improve the performance experience, increase memory and the
+      # number of workers
+      #
+      LSMB_WORKERS: 2
+      #
+      #
+      # SSMTP_ROOT:
+      # SSMTP_HOSTNAME:
+      # SSMTP_MAILHUB:
+      # SSMTP_AUTH_USER:
+      # SSMTP_AUTH_PASS:
+      # SSMTP_AUTH_METHOD:
+      # SSMTP_USE_STARTTLS:
+      # SSMTP_FROMLINE_OVERRIDE:
+
+# 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:

start.sh

@@ -45,4 +45,4 @@ echo "Selected PERL5LIB=$PERL5LIB";
 # --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 --preload-app tools/starman.psgi
+exec starman --port 5762 --workers ${LSMB_WORKERS:-5} --preload-app tools/starman.psgi