* 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

@@ -1,11 +1,27 @@
-FROM        debian:jessie
+FROM        debian:jessie-slim
 MAINTAINER  Freelock john@freelock.com
 
-RUN echo -n "APT::Install-Recommends \"0\";\nAPT::Install-Suggests \"0\";\n" >> /etc/apt/apt.conf
-ENV DEBIAN_FRONTEND=noninteractive
+# Build time variables
+ENV LSMB_VERSION 1.5.28
+
 
 # Install Perl, Tex, Starman, psql client, and all dependencies
-RUN apt-get update && apt-get dist-upgrade -y && apt-get -y install \
+# Without libclass-c3-xs-perl, performance is terribly slow...
+
+# 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
+
+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/ && \
+  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/ && \
+  DEBIAN_FRONTEND=noninteractive apt-get update && \
+    apt-get dist-upgrade -y && apt-get -y install \
+    curl wget ca-certificates \
     libcgi-emulate-psgi-perl libcgi-simple-perl libconfig-inifiles-perl \
     libdbd-pg-perl libdbi-perl libdatetime-perl \
     libdatetime-format-strptime-perl libdigest-md5-perl \
@@ -17,36 +33,33 @@ RUN apt-get update && apt-get dist-upgrade -y && apt-get -y install \
     libpgobject-util-dbmethod-perl libplack-perl libtemplate-perl \
     libnamespace-autoclean-perl \
     libtemplate-plugin-latex-perl libtex-encode-perl \
-    libmoosex-nonmoose-perl \
+    libmoosex-nonmoose-perl libclass-c3-xs-perl \
     texlive-latex-recommended \
-    texlive-xetex \
+    texlive-xetex fonts-liberation \
     starman \
     libopenoffice-oodoc-perl \
     postgresql-client \
     ssmtp \
-    lsb-release
-
-
-# Build time variables
-ENV LSMB_VERSION 1.5.8
-
-# Install LedgerSMB
-RUN apt-get -y install git cpanminus make gcc libperl-dev && \
-    cd /srv && \
-    curl -Lo ledgersmb-$LSMB_VERSION.tar.gz "https://github.com/ledgersmb/LedgerSMB/releases/download/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz" && \
-    tar -xvzf ledgersmb-$LSMB_VERSION.tar.gz && \
-    rm -f ledgersmb-$LSMB_VERSION.tar.gz && \
-    cd ledgersmb && \
+    lsb-release && \
+  echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list && \
+  (wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add -) && \
+  DEBIAN_FRONTEND="noninteractive" apt-get -y update && \
+  DEBIAN_FRONTEND="noninteractive" apt-get -y install postgresql-client && \
+  DEBIAN_FRONTEND=noninteractive apt-get -y install git cpanminus make gcc libperl-dev && \
+    curl -Lo /tmp/ledgersmb-$LSMB_VERSION.tar.gz "https://download.ledgersmb.org/f/Releases/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz" && \
+    tar -xvzf /tmp/ledgersmb-$LSMB_VERSION.tar.gz --directory /srv && \
+    rm -f /tmp/ledgersmb-$LSMB_VERSION.tar.gz && \
     cpanm --quiet --notest \
       --with-feature=starman \
       --with-feature=latex-pdf-ps \
       --with-feature=openoffice \
-      --installdeps . && \
+      --installdeps /srv/ledgersmb/ && \
     apt-get purge -y git cpanminus make gcc libperl-dev && \
     apt-get autoremove -y && \
     apt-get autoclean && \
-    rm -rf ~/.cpanm/
-   
+    rm -rf ~/.cpanm/ && \
+    rm -rf /var/lib/apt/lists/* /usr/share/man/*
+
 
 WORKDIR /srv/ledgersmb
 
@@ -81,8 +94,6 @@ RUN mkdir -p /tmp && \
 
 # Internal Port Expose
 EXPOSE 5762
-# If ledgersmb.conf does not exist, www-data user needs to be able to create it.
-RUN chown www-data /srv/ledgersmb
-USER www-data
 
+USER www-data
 CMD ["start.sh"]

README.md

@@ -1,110 +1,182 @@
 # 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!
+# Supported tags
 
-# Supported tags and respective `Dockerfile` links
-
-- `1.5.x`, `latest` - Latest release tarball from 1.5 branch
+- `1.5`, `1.5.x`, `latest` - Latest release tarball from 1.5 branch
 - `1.4`, `1.4.x` - Latest tagged release of git 1.4 branch
--	`dev-master` - Master (1.6) branch from git, unstable, updated only on demand
-- `1.5` - Develop HEAD of 1.5 branch, updated only on demand
+- `master` - Master branch from git, unstable
+- `master-dev`, `1.5-dev` - Containers to kick off a development setup
 
 
 # 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 5762. 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 not recommend 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 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.
+
+# 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
 
-	docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d postgres
+```plain
+ $ docker run -d --name postgres \
+              -e POSTGRES_PASSWORD=mysecretpassword \
+              postgres:latest
+```
 
-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`.
+BEWARE: The command above creates a container with the database data stored
+*inside* the container. Upon removal of the container, the database data will
+be removed too!
 
-> The postgres database is a default database meant for use by users, utilities and third party applications.  
-> [postgresql.org/docs](http://www.postgresql.org/docs/9.3/interactive/app-initdb.html)
+To prevent destruction of the database data upon replacement of the container,
+please use these commands instead:
+
+```plain
+ $ docker volume create dbdata
+ $ docker run -d --name postgres \
+              -e POSTGRES_PASSWORD=mysecretpassword \
+              -e PGDATA=/var/lib/postgresql/data/pgdata \
+              -v dbdata:/var/lib/postgresql/data \
+              postgres:latest
+```
 
 ## Start LedgerSMB
 
-	docker run --name myledger --link some-postgres:postgres -d ledgersmb/ledgersmb
+```plain
+ $ docker run -d -p 5762:5762 --name myledger \
+              ledgersmb/ledgersmb:latest
+```
+
+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.
 
 ## Set up LedgerSMB
 
-Visit http://myledger:5762/setup.pl (you can forward port 5762 to the host machine, or lookup the IP address for the "myledger" container if running on localhost)
+ * Visit http://myledger:5762/setup.pl.
+ * Log in with the "postgres" user and the password `mysecretpassword`
+   and provide the name of a company (= database name) you want to create.
+ * Go over the steps presented in the browser
 
-Log in with the "postgres" user and the password you set when starting up the Postgres container, and provide the name of a company database you want to create.
+Once you have completed the setup steps, you have a fully functional
+LedgerSMB instance running!
 
-Once you have completed the setup, you have a fully functional LedgerSMB instance running!
-
-Visit http://myledger:5762/login.pl to log in and get started.
+Visit http://localhost:5762/login.pl to log in and get started.
 
 # Updating the LedgerSMB container
 
-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.
+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 as often as you want.
 
 # Environment Variables
 
-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.
+The LedgerSMB image uses several environment variables. They are all optional.
 
-### `POSTGRES_HOST` = 'postgres'
 
-This environment variable is used to specify the hostname of the Postgres server. The default is "postgres", which will find the container linked in.
+## `POSTGRES_HOST`
 
-If you set this to another hostname, LedgerSMB will attempt to connect to that hostname instead.
+Default: postgres
 
-## `POSTGRES_PORT` = 5432
+Specifies the hostname of the PostgreSQL server to connect to. If you use
+a PostgreSQL image, set it to the name of that image.
 
-Port to connect to Postgres on. Use to connect to a Postgres server running on an alternate port.
+## `POSTGRES_PORT`
 
-## `DEFAULT_DB` = lsmb
+Default: 5432
 
-Set this if you want to automatically log in to a particular LSMB database.
+Port on which the PostgreSQL server is running.
 
-### `SSMTP_ROOT` `SSMTP_MAILHUB` `SSMTP_HOSTNAME` `SSMTP_USE_STARTTLS` `SSMTP_AUTH_USER` `SSMTP_AUTH_PASS` `SSMTP_METHOD` `SSMTP_FROMLINE_OVERRIDE`
+## `DEFAULT_DB`
 
-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.
+Default: lsmb
 
-Use the other environment variables to relay mail through another host.
+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`)
+* `SSMTP_USE_STARTTLS` (config: `UseSTARTTLS`)
+* `SSMTP_AUTH_USER` (config: `AuthUser`)
+* `SSMTP_AUTH_PASS` (config: `AuthPass`)
+* `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
+the root and hostname set.
+
+Use the other environment variables to relay mail through a different host.
+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.
 
 # 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.11.1.
-
-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).
 
-You can also reach some of the official LedgerSMB maintainers via the `#ledgersmb` IRC channel on [Freenode](https://freenode.net), or on the bridged [Matrix](https://matrix.org) room in [#ledgersmb:matrix.org](https://matrix.to/#/#ledgersmb:matrix.org). The [Vector.im](https://vector.im/beta/#/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), or on the bridged [Matrix](https://matrix.org) room in [#ledgersmb:matrix.org](https://matrix.to/#/#ledgersmb:matrix.org). The [Riot.im](https://riot.im/app/#/room/#ledgersmb:matrix.org) Matrix client is highly recommended.
 
 
 ## Contributing

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

@@ -4,14 +4,20 @@ update_ssmtp.sh
 cd /srv/ledgersmb
 
 if [[ ! -f ledgersmb.conf ]]; then
-  cp conf/ledgersmb.conf.default ledgersmb.conf
-  sed -i \
-    -e "s/\(cache_templates = \).*\$/cache_templates = 1/g" \
-    -e "s/\(host = \).*\$/\1$POSTGRES_HOST/g" \
-    -e "s/\(port = \).*\$/\1$POSTGRES_PORT/g" \
-    -e "s/\(default_db = \).*\$/\1$DEFAULT_DB/g" \
-    -e "s%\(sendmail   = \).*%\1/usr/sbin/ssmtp%g" \
-    /srv/ledgersmb/ledgersmb.conf
+  cat <<EOF >/tmp/ledgersmb.conf
+[main]
+cache_templates = 1
+
+[database]
+host = $POSTGRES_HOST
+port = $POSTGRES_PORT
+default_db = $DEFAULT_DB
+
+[mail]
+sendmail   = /usr/sbin/ssmtp
+
+EOF
+  export LSMB_CONFIG_FILE='/tmp/ledgersmb.conf'
 fi
 
 if [ ! -f "/tmp/ledgersmb" ]; then
@@ -26,6 +32,7 @@ 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";
@@ -38,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