Compare commits

...

40 Commits
1.12 ... 1.7.36

Author SHA1 Message Date
Erik Huelsmann
fed8a29266 * Automatic Dockerfile update by release process 2021-10-12 15:35:11 -04:00
Erik Huelsmann
6ddc8da10d Set the reverse proxy address to the default Docker address range 2021-09-17 23:03:40 +02:00
Erik Huelsmann
b46592f2cb Add reverse proxy configuration option 2021-09-17 22:40:42 +02:00
Erik Huelsmann
5717494020 * Automatic Dockerfile update by release process 2021-09-03 14:08:36 -04:00
Erik Huelsmann
6e529873ae Add libclass-accessor-lite-perl dependency explicitly because it fails to build 2021-08-30 01:08:29 +02:00
Erik Huelsmann
13572ee685 Use multi-stage build to derive dependency packages 2021-08-30 00:56:17 +02:00
Erik Huelsmann
2056ad56cb * Automatic Dockerfile update by release process 2021-08-25 16:50:01 -04:00
Erik Huelsmann
3658a14ccd * Automatic Dockerfile update by release process 2021-08-23 07:27:15 -04:00
Erik Huelsmann
f114db8fcb Print commands as they are executed (debugging purposes) 2021-08-13 23:57:07 +02:00
Erik Huelsmann
2849671500 Make the artifact location into a build ARG 2021-08-13 23:43:51 +02:00
Erik Huelsmann
bdebd44ae0
Update README.md 2021-07-10 23:54:48 +02:00
Erik Huelsmann
c95e4b4b9d
Update README.md 2021-07-10 23:50:06 +02:00
Erik Huelsmann
7c89b26987 * Automatic Dockerfile update by release process 2021-07-08 18:07:40 -04:00
Erik Huelsmann
cd7f62abc6 * Automatic Dockerfile update by release process 2021-06-14 14:42:45 -04:00
Erik Huelsmann
d518733d23 * Automatic Dockerfile update by release process 2021-06-03 14:41:51 -04:00
Erik Huelsmann
53c4e6ac92 * Automatic Dockerfile update by release process 2021-05-29 15:02:16 -04:00
Erik Huelsmann
78b902ddc9 * Automatic Dockerfile update by release process 2021-05-02 12:54:03 -04:00
Erik Huelsmann
c1fee69d52 * Automatic Dockerfile update by release process 2021-03-21 08:26:45 -04:00
Erik Huelsmann
33d4019521 * Automatic Dockerfile update by release process 2021-01-31 18:28:17 +00:00
Erik Huelsmann
2a138c50f2 * Automatic Dockerfile update by release process 2020-12-14 22:00:15 +00:00
Erik Huelsmann
11baa4c0a0 * Automatic Dockerfile update by release process 2020-11-18 20:39:19 +00:00
Erik Huelsmann
7e914dbfd1 * Automatic Dockerfile update by release process 2020-09-27 18:57:27 +00:00
Erik Huelsmann
1a1d294e31 * Automatic Dockerfile update by release process 2020-09-18 07:49:04 +00:00
Erik Huelsmann
44b544c8ba * Automatic Dockerfile update by release process 2020-09-13 19:20:04 +00:00
Erik Huelsmann
5dc7176b3f * Automatic Dockerfile update by release process 2020-09-04 19:18:29 +00:00
Erik Huelsmann
f25dee9473 * Automatic Dockerfile update by release process 2020-08-28 21:35:51 +00:00
Erik Huelsmann
0332a27535
Re #23: Add dependency on texlive-fonts-recommended 2020-08-24 22:46:32 +02:00
Erik Huelsmann
19c6b2d6df * Automatic Dockerfile update by release process 2020-07-25 09:08:22 +00:00
Erik Huelsmann
6ff37dc952 * Automatic Dockerfile update by release process 2020-06-29 09:25:07 +00:00
Erik Huelsmann
da234d021d * Automatic Dockerfile update by release process 2020-06-21 21:05:58 +00:00
Erik Huelsmann
ffb7ff1a09 Map the LedgerSMB port (5762) explicitly to local loopback (only) 2020-06-17 21:44:13 +02:00
Erik Huelsmann
966c1fd043 * Automatic Dockerfile update by release process 2020-05-31 12:42:56 +00:00
Erik Huelsmann
ba98f4c5c0 Update README to include 1.8 tag 2020-05-31 11:22:32 +02:00
Erik Huelsmann
20bd26798a * Automatic Dockerfile update by release process 2020-05-23 21:50:43 +00:00
Erik Huelsmann
f4bc2c874f * Automatic Dockerfile update by release process 2020-05-06 19:12:40 +00:00
Erik Huelsmann
0897045096 * Automatic Dockerfile update by release process 2020-04-27 15:17:44 +00:00
Erik Huelsmann
53ab84cbaa Update README.md 2020-04-12 21:34:14 +02:00
Erik Huelsmann
760c5c0138 * Automatic Dockerfile update by release process 2020-04-11 18:39:34 +00:00
Erik Huelsmann
8930ac395d * Automatic Dockerfile update by release process 2020-03-07 15:14:25 +00:00
Erik Huelsmann
1bbf65543b Update README.md to set correct list of supported tags 2020-03-07 15:38:14 +01:00
4 changed files with 128 additions and 67 deletions

View File

@ -1,9 +1,53 @@
FROM debian:stretch-slim
# Build time variables
ARG SRCIMAGE=debian:stretch-slim
FROM $SRCIMAGE AS builder
ARG LSMB_VERSION="1.7.36"
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 -y update && \
DEBIAN_FRONTEND="noninteractive" apt-get -y upgrade && \
DEBIAN_FRONTEND="noninteractive" apt-get -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
MAINTAINER Freelock john@freelock.com
# Build time variables
ARG LSMB_VERSION="1.7.9"
ARG LSMB_VERSION="1.7.36"
ARG LSMB_DL_DIR="Releases"
ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz"
# Install Perl, Tex, Starman, psql client, and all dependencies
# Without libclass-c3-xs-perl, performance is terribly slow...
@ -16,12 +60,11 @@ 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 && \
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/ && \
@ -33,31 +76,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 \
libdbd-pg-perl libdbi-perl libdata-uuid-perl libdatetime-perl \
libdatetime-format-strptime-perl \
libio-stringy-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 \
libmoosex-nonmoose-perl libnumber-format-perl \
libpgobject-perl libpgobject-simple-perl libpgobject-simple-role-perl \
libpgobject-type-bigfloat-perl libpgobject-type-datetime-perl \
libpgobject-type-bytestring-perl libpgobject-util-dbmethod-perl \
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 \
libnamespace-autoclean-perl \
libfile-find-rule-perl \
libtemplate-plugin-latex-perl libtex-encode-perl \
$( cat /tmp/derived-deps ) \
libclass-c3-xs-perl libclass-accessor-lite-perl \
libnet-cidr-lite-perl \
texlive-latex-recommended \
texlive-latex-recommended texlive-fonts-recommended \
texlive-xetex fonts-liberation \
starman \
libopenoffice-oodoc-perl \
ssmtp \
lsb-release && \
echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list && \
@ -65,7 +87,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 "$ARTIFACT_LOCATION" && \
tar -xzf /tmp/ledgersmb-$LSMB_VERSION.tar.gz --directory /srv && \
rm -f /tmp/ledgersmb-$LSMB_VERSION.tar.gz && \
cpanm --notest \

View File

@ -1,12 +1,18 @@
# ledgersmb-docker
Dockerfile for LedgerSMB Docker image
# Supported tags
- `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
- `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.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
- `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.
# What is LedgerSMB?
@ -23,9 +29,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 not recommend exposing this port publicly, because
do recommend not exposing this port publicly, because
1. The Starman author recommends it
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
@ -34,33 +40,45 @@ 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
# How to use this image
The quickest way to get this image up and running is by using the
`docker-compose` file available through the GitHub repository at:
This image can be installed either automatically with the Docker compose file
or manually with docker only.
https://github.com/ledgersmb/ledgersmb-docker/blob/1.7/docker-compose.yml
## Docker-Compose installation and start
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:
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:
```plain
username: postgres
password: abc
```
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).
From here, follow the steps as detailed in the instructions for
[preparing for first use](https://ledgersmb.org/content/preparing-ledgersmb-17-first-use).
## 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 \
@ -74,7 +92,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 -
@ -130,21 +148,18 @@ affect the performance experience of users.
## Mail configuration
The docker image uses `ssmtp` to send mail.
### Before 1.8.0
* `SSMTP_ROOT` (config: `Root`)
These variables are used to set outgoing SMTP defaults.
* `SSMTP_ROOT` (config: `Root` -- DEPRECATED)
* `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_AUTH_METHOD` (config: `AuthMethod` -- DEPRECATED)
* `SSMTP_FROMLINE_OVERRIDE` (config: `FromLineOverride` -- DEPRECATED)
`SSMTP_MAILHUB` defaults to the default docker0 interface, so if your host is
already configured to relay mail, this should relay successfully with only
@ -155,6 +170,25 @@ 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

View File

@ -32,14 +32,8 @@ services:
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"
ports:
- "127.0.0.1:5762:5762"
environment:
# The LSMB_WORKERS environment variable lets you select the number
# of processes serving HTTP requests. The default number of 2 workers
@ -58,6 +52,15 @@ services:
# SSMTP_AUTH_METHOD:
# SSMTP_USE_STARTTLS:
# SSMTP_FROMLINE_OVERRIDE:
#
#
# 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
# having the dbdata volume is required to persist our
# data between PostgreSQL container updates; without

View File

@ -16,6 +16,8 @@ default_db = $DEFAULT_DB
[mail]
sendmail = /usr/sbin/ssmtp
[proxy]
ip=${PROXY_IP:-172.17.0.1/12}
EOF
export LSMB_CONFIG_FILE='/tmp/ledgersmb.conf'
fi