Compare commits

..

32 Commits
1.8 ... 1.9.6

Author SHA1 Message Date
Erik Huelsmann
1806b8003b * Automatic Dockerfile update by release process 2022-01-05 14:50:17 -05:00
Erik Huelsmann
d9163c1e65 Remove stale comments 2021-12-11 23:40:50 +01:00
Erik Huelsmann
9e88db52d9 Add advanced docker-compose configuration showing reverse proxy example 2021-12-11 22:24:01 +01:00
Erik Huelsmann
230a7ddfae Clarify and simplify use of the containers 2021-12-11 21:39:51 +01:00
Erik Huelsmann
3a86482a97 Update environment variables of mail configuration
[skip ci]
2021-12-11 20:56:18 +01:00
Erik Huelsmann
ae0cea34b3 * Automatic Dockerfile update by release process 2021-12-08 16:09:19 -05:00
Erik Huelsmann
f37678c275 * Automatic Dockerfile update by release process 2021-11-25 16:42:45 -05:00
Erik Huelsmann
b28f5b693b * Automatic Dockerfile update by release process 2021-11-14 05:26:33 -05:00
Erik Huelsmann
1f20ab08f1 * Automatic Dockerfile update by release process 2021-10-12 16:39:27 -04:00
Erik Huelsmann
34937fbd4f * Automatic Dockerfile update by release process 2021-10-01 06:31:50 -04:00
Erik Huelsmann
c6968b5397 Update README.md
Move 'latest' tag from 1.8 to 1.9.
2021-09-24 23:29:11 +02:00
Erik Huelsmann
5168936493 * Automatic Dockerfile update by release process 2021-09-24 16:08:51 -04:00
Erik Huelsmann
49a448c732 Change PostgreSQL container version
Close #28.
2021-09-23 16:38:44 +02:00
Erik Huelsmann
27b3e40e72 * Automatic Dockerfile update by release process 2021-09-18 16:43:48 -04:00
Erik Huelsmann
6593d58698 Set the reverse proxy address to the default Docker address range 2021-09-17 23:04:21 +02:00
Erik Huelsmann
5a7ec0a2ed Add reverse proxy configuration option 2021-09-17 22:41:06 +02:00
Erik Huelsmann
236a25b767 * Automatic Dockerfile update by release process 2021-09-12 16:22:35 -04:00
Erik Huelsmann
943fa166e8 Update start.sh
The starman option `max-workers` actually does not exist...
2021-09-12 22:19:04 +02:00
Erik Huelsmann
a678ae39a0 Use multi-stage build to compile list of dependency packages 2021-08-30 00:13:57 +02:00
Erik Huelsmann
3d12e4351d Align dependencies (after review against master branch) 2021-08-29 21:55:58 +02:00
Erik Huelsmann
ccd90f04a4 Upgrade MAINTAINER to LABEL 2021-08-29 21:20:13 +02:00
Erik Huelsmann
4d316f9019 Use Debian Bullseye as the basis for 1.9 images 2021-08-29 21:00:50 +02:00
Erik Huelsmann
71f876a253 * Automatic Dockerfile update by release process 2021-08-29 14:44:44 -04:00
Erik Huelsmann
ab00872e02 Update README.md 2021-08-28 17:32:47 +02:00
Erik Huelsmann
483a1110ff * Automatic Dockerfile update by release process 2021-08-18 17:35:58 -04:00
Erik Huelsmann
a2a625d193 Print commands as they are executed (debugging purposes) 2021-08-13 23:55:06 +02:00
Erik Huelsmann
f10924cae9 Make the artifact location into a build ARG 2021-08-13 23:46:46 +02:00
Erik Huelsmann
c13d20651c Update README.md 2021-07-10 23:54:23 +02:00
Erik Huelsmann
7771b8c03b Update README.md 2021-07-10 23:51:02 +02:00
Erik Huelsmann
1ba89cef50 Update Dockerfile
Make sure `iftex` package is installed
2021-06-12 22:34:34 +02:00
Erik Huelsmann
d7ad535199 Update docker-compose.yml
Refer to the 1.9 tag for the docker images
2021-06-11 23:15:10 +02:00
Erik Huelsmann
ac2553ea17 Branch 1.9 and create 1.9.0-alpha1 container 2021-03-20 00:05:07 +01:00
7 changed files with 196 additions and 68 deletions

View File

@@ -1,9 +0,0 @@
# Configuration for probot-no-response - https://github.com/probot/no-response
# Number of days of inactivity before an Issue is closed for lack of response
daysUntilClose: 90
# Label requiring a response
responseRequiredLabel: waiting-for-user
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
closeComment: >
Closing: more than 90 days without user response. Feel free to reopen with your comments.

View File

@@ -1,11 +1,11 @@
# Build time variables
ARG SRCIMAGE=debian:buster-slim
ARG SRCIMAGE=debian:bullseye-slim
FROM $SRCIMAGE AS builder
ARG LSMB_VERSION="1.8.31"
ARG LSMB_VERSION="1.9.6"
ARG LSMB_DL_DIR="Releases"
ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz"
@@ -41,13 +41,13 @@ RUN set -x ; \
FROM $SRCIMAGE
MAINTAINER Freelock john@freelock.com
LABEL org.opencontainers.image.authors="LedgerSMB project <devel@lists.ledgersmb.org>"
# Build time variables
ARG LSMB_VERSION="1.8.31"
ARG LSMB_VERSION="1.9.6"
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...
@@ -56,6 +56,7 @@ ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSI
# Install Locale::Codes Locale::Country Locale::Language from CPAN to suppress
# deprecation-as-core-module warning
COPY --from=builder /srv/derived-deps /tmp/derived-deps
RUN set -x ; \
@@ -67,13 +68,14 @@ RUN set -x ; \
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 -y update && \
DEBIAN_FRONTEND="noninteractive" apt-get -y upgrade && \
DEBIAN_FRONTEND="noninteractive" apt-get -y install \
wget ca-certificates gnupg \
$( cat /tmp/derived-deps ) \
libclass-c3-xs-perl \
texlive-latex-recommended texlive-fonts-recommended \
texlive-plain-generic texlive-latex-recommended texlive-fonts-recommended \
texlive-xetex fonts-liberation \
lsb-release && \
echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list && \
@@ -84,7 +86,6 @@ 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 && \
cpanm --reinstall --notest Locale::Country Locale::Codes Locale::Language && \
cpanm --notest \
--with-feature=starman \
--with-feature=latex-pdf-ps \

117
README.md
View File

@@ -4,17 +4,16 @@ Dockerfile for LedgerSMB Docker image
# Supported tags
- `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)
- `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
- `master` - Master branch from git, unstable
Containers supporting the development process are provided
through the [ledgersmb-dev-docker project](https://github.com/ledgersmb/ledgersmb-dev-docker/blob/master/README.md#getting-started).
through the ledgersmb-dev-docker project. See https://github.com/ledgersmb/ledgersmb-dev-docker/blob/master/README.md#getting-started.
# What is LedgerSMB?
@@ -47,7 +46,7 @@ could require additional setup of a mail service or CUPS printer service.
This image can be installed either automatically with the Docker compose file
or manually with docker only.
## Docker-Compose installation and start
## 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,
@@ -60,24 +59,24 @@ variables, are:
$ docker-compose up -d
```
Or use the following to set a different password and/or parallel processing
capacity (so called 'workers'):
```plain
$ docker-compose pull
$ POSTGRES_PASSWORD=def \
LSMB_WORKERS=10 \
docker-compose up -d
```
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 containers will be running in the background and can be stopped
and started by running:
server. Your LedgerSMB installation should now be accessible through
[http://localhost:5762/](http://localhost:5762/).
```plain
# Stopping the containers
$ docker-compose stop
# Starting the containers
$ docker-compose start
```
(Check the status of the containers using `docker-compose ps`; when the
containers are running, the `State` column shows `Up`.)
The database username and password are:
The default number of workers is 5. The default database username and password
are:
```plain
username: postgres
@@ -85,7 +84,7 @@ The database username and password are:
```
From here, follow the steps as detailed in the instructions for
[preparing for first use](https://ledgersmb.org/content/preparing-ledgersmb-17-first-use).
[preparing for first use](https://ledgersmb.org/content/preparing-ledgersmb-19-first-use).
## Manual installation
@@ -124,9 +123,13 @@ Visit http://localhost:5762/login.pl to log in and get started.
No persistant data is stored in the LedgerSMB container.
All LedgerSMB data is stored in Postgres, so you can stop/destroy/run a
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.
@@ -162,8 +165,6 @@ affect the performance experience of users.
## Mail configuration
### 1.8.0 and higher
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
@@ -179,28 +180,51 @@ The following parameters are now supported to set mail preferences:
* `LSMB_MAIL_SMTPPASS`
* `LSMB_MAIL_SMTPAUTHMECH`
# Advanced setup
### Before 1.8.0
## Docker Compose with reverse proxy
These variables are used to set outgoing SMTP defaults.
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:
* `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` -- DEPRECATED)
* `SSMTP_FROMLINE_OVERRIDE` (config: `FromLineOverride` -- DEPRECATED)
```plain
$ docker-compose \
-f docker-compose.yml \
-f docker-compose-reverseproxy.yml \
up -d
```
`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.
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/).
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.
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
@@ -217,9 +241,8 @@ please contact us on the [mailing list](http://ledgersmb.org/topic/support/maili
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 [Riot.im](https://riot.im/app/#/room/#ledgersmb:matrix.org) Matrix client is highly recommended.
[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.
## Contributing

View File

@@ -0,0 +1,31 @@
# 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:
image: nginx:1-alpine
volumes:
- "lsmbdata:/srv/ledgersmb"
- "./nginx.conf:/etc/nginx/nginx.conf"
ports:
- "8080:8080"
lsmb:
volumes:
- "lsmbdata:/srv/ledgersmb"
volumes:
lsmbdata:

View File

@@ -16,10 +16,10 @@ services:
# because that allows us to use the default hostname ("postgres")
# from the LedgerSMB configuration
postgres:
image: postgres:9.6-alpine
image: postgres:12-alpine
environment:
# Replace the password below for a secure setup
POSTGRES_PASSWORD: abc
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-abc}
PGDATA: /var/lib/postgresql/data/pgdata
networks:
- internal
@@ -28,7 +28,7 @@ services:
lsmb:
depends_on:
- postgres
image: ghcr.io/ledgersmb/ledgersmb:1.8
image: ledgersmb/ledgersmb:1.9
networks:
- internal
- default
@@ -47,9 +47,10 @@ services:
# improve the performance experience, increase memory and the
# number of workers
#
LSMB_WORKERS: 2
LSMB_WORKERS: ${LSMB_WORKERS:-5}
#
#
# LSMB_MAIL_SMTPHOST:
# LSMB_MAIL_SMTPPORT:
# LSMB_MAIL_SMTPTLS:

81
nginx.conf Normal file
View File

@@ -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;
}
}
}

View File

@@ -102,6 +102,6 @@ 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 :5762: --max-workers ${LSMB_WORKERS:-5} \
exec starman --listen :5762: --workers ${LSMB_WORKERS:-5} \
-I lib -I old/lib \
--preload-app bin/ledgersmb-server.psgi