Compare commits

..

18 Commits
1.12 ... 1.8.20

Author SHA1 Message Date
Erik Huelsmann
6659f8f8ae * Automatic Dockerfile update by release process 2021-09-03 14:17:32 -04:00
Erik Huelsmann
59df4ddefd Use multi-stage build to derive dependency packages 2021-08-30 00:48:44 +02:00
Erik Huelsmann
b02d6b1044 * Automatic Dockerfile update by release process 2021-08-25 17:11:56 -04:00
Erik Huelsmann
1f9e54cbe8 * Automatic Dockerfile update by release process 2021-08-23 07:49:49 -04:00
Erik Huelsmann
955812f36b
Update README.md 2021-08-17 13:50:41 +02:00
Erik Huelsmann
4f5f8e8cbf Print commands as they are executed (debugging purposes) 2021-08-13 23:55:50 +02:00
Erik Huelsmann
b7502825f1 Make the artifact location into a build ARG 2021-08-13 23:45:10 +02:00
Erik Huelsmann
3d73729575
Update README.md 2021-08-04 23:56:15 +02:00
Erik Huelsmann
f9aeeaad75
Update README.md 2021-08-04 23:55:28 +02:00
Erik Huelsmann
f7f7ecf3a1 * Automatic Dockerfile update by release process 2021-07-28 17:09:34 -04:00
Erik Huelsmann
4772312182
Update README.md 2021-07-10 23:54:05 +02:00
Erik Huelsmann
c5c6011073
Update README.md 2021-07-10 23:47:17 +02:00
Erik Huelsmann
db941843fb * Automatic Dockerfile update by release process 2021-07-10 13:34:58 -04:00
Erik Huelsmann
ae687da108 * Automatic Dockerfile update by release process 2021-06-14 14:55:24 -04:00
Erik Huelsmann
6bc115c7e6 * Automatic Dockerfile update by release process 2021-06-03 15:05:08 -04:00
Erik Huelsmann
d7bf3b30a0 * Automatic Dockerfile update by release process 2021-05-29 15:06:27 -04:00
Erik Huelsmann
8d6e8fe95b * Automatic Dockerfile update by release process 2021-05-02 13:05:16 -04:00
Erik Huelsmann
3156651671 * Automatic Dockerfile update by release process 2021-03-21 09:02:57 -04:00
8 changed files with 135 additions and 501 deletions

View File

@ -1,18 +0,0 @@
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

View File

@ -1,26 +0,0 @@
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.

View File

@ -1,19 +1,19 @@
# Build time variables # Build time variables
ARG SRCIMAGE=debian:bookworm-slim ARG SRCIMAGE=debian:buster-slim
FROM $SRCIMAGE AS builder FROM $SRCIMAGE AS builder
ARG LSMB_VERSION="1.12.7" ARG LSMB_VERSION="1.8.20"
ARG LSMB_DL_DIR="Releases" ARG LSMB_DL_DIR="Releases"
ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz" ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz"
RUN set -x ; \ RUN set -x ; \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y update && \ DEBIAN_FRONTEND="noninteractive" apt-get -y update && \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y dist-upgrade && \ DEBIAN_FRONTEND="noninteractive" apt-get -y upgrade && \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y install dh-make-perl libmodule-cpanfile-perl git wget && \ DEBIAN_FRONTEND="noninteractive" apt-get -y install dh-make-perl libmodule-cpanfile-perl git wget && \
apt-file update apt-file update
RUN set -x ; \ RUN set -x ; \
@ -41,25 +41,20 @@ RUN set -x ; \
FROM $SRCIMAGE FROM $SRCIMAGE
LABEL org.opencontainers.image.authors="LedgerSMB project <devel@lists.ledgersmb.org>" MAINTAINER Freelock john@freelock.com
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" # Build time variables
ARG LSMB_VERSION="1.8.20"
ARG LSMB_DL_DIR="Releases" ARG LSMB_DL_DIR="Releases"
ARG ARTIFACT_LOCATION="https://download.ledgersmb.org/f/$LSMB_DL_DIR/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz" 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...
### PACKAGE REQUIREMENTS RATIONALE # 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
# postgresql-client(from apt.postgresql.org): reduces chances running a newer server than this client # Install Locale::Codes Locale::Country Locale::Language from CPAN to suppress
# fonts-liberation: installed for compatibility with templates from 1.8 and earlier # deprecation-as-core-module warning
COPY --from=builder /srv/derived-deps /tmp/derived-deps COPY --from=builder /srv/derived-deps /tmp/derived-deps
@ -72,30 +67,32 @@ RUN set -x ; \
mkdir -p /usr/share/man/man5/ && \ mkdir -p /usr/share/man/man5/ && \
mkdir -p /usr/share/man/man6/ && \ mkdir -p /usr/share/man/man6/ && \
mkdir -p /usr/share/man/man7/ && \ mkdir -p /usr/share/man/man7/ && \
mkdir -p /usr/share/man/man8/ && \ DEBIAN_FRONTEND="noninteractive" apt-get -y update && \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y update && \ DEBIAN_FRONTEND="noninteractive" apt-get -y upgrade && \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y dist-upgrade && \ DEBIAN_FRONTEND="noninteractive" apt-get -y install \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y install \ wget ca-certificates gnupg \
wget ca-certificates gnupg iproute2 \
$( cat /tmp/derived-deps ) \ $( cat /tmp/derived-deps ) \
texlive-plain-generic texlive-latex-recommended texlive-fonts-recommended \ libclass-c3-xs-perl \
texlive-latex-recommended texlive-fonts-recommended \
texlive-xetex fonts-liberation \ texlive-xetex fonts-liberation \
lsb-release postgresql-common && \ lsb-release && \
/usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y && \ echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list && \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y update && \ (wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add -) && \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y install postgresql-client && \ DEBIAN_FRONTEND="noninteractive" apt-get -y update && \
DEBIAN_FRONTEND="noninteractive" apt-get -y install postgresql-client && \
DEBIAN_FRONTEND="noninteractive" apt-get -q -y install git cpanminus make gcc libperl-dev && \ 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" && \ wget --quiet -O /tmp/ledgersmb-$LSMB_VERSION.tar.gz "$ARTIFACT_LOCATION" && \
tar -xzf /tmp/ledgersmb-$LSMB_VERSION.tar.gz --directory /srv && \ tar -xzf /tmp/ledgersmb-$LSMB_VERSION.tar.gz --directory /srv && \
rm -f /tmp/ledgersmb-$LSMB_VERSION.tar.gz && \ rm -f /tmp/ledgersmb-$LSMB_VERSION.tar.gz && \
cpanm --metacpan --notest \ cpanm --reinstall --notest Locale::Country Locale::Codes Locale::Language && \
cpanm --notest \
--with-feature=starman \ --with-feature=starman \
--with-feature=latex-pdf-ps \ --with-feature=latex-pdf-ps \
--with-feature=openoffice \ --with-feature=openoffice \
--installdeps /srv/ledgersmb/ && \ --installdeps /srv/ledgersmb/ && \
DEBIAN_FRONTEND="noninteractive" apt-get purge -q -y git cpanminus make gcc libperl-dev && \ apt-get purge -q -y git cpanminus make gcc libperl-dev && \
DEBIAN_FRONTEND="noninteractive" apt-get autoremove -q -y && \ apt-get autoremove -q -y && \
DEBIAN_FRONTEND="noninteractive" apt-get clean -q && \ apt-get clean -q && \
rm -rf ~/.cpanm/ /var/lib/apt/lists/* /usr/share/man/* rm -rf ~/.cpanm/ /var/lib/apt/lists/* /usr/share/man/*
@ -106,27 +103,23 @@ WORKDIR /srv/ledgersmb
# Configure outgoing mail to use host, other run time variable defaults # Configure outgoing mail to use host, other run time variable defaults
## MAIL ## MAIL
# '__CONTAINER_GATEWAY__' is a magic value which will be substituted ENV LSMB_MAIL_SMTPHOST 172.17.0.1
# with the actual gateway IP address #ENV LSMB_MAIL_SMTPPORT 25
ENV LSMB_MAIL_SMTPHOST=__CONTAINER_GATEWAY__ #ENV LSMB_MAIL_SMTPSENDER_HOSTNAME (container hostname)
#ENV LSMB_MAIL_SMTPPORT=25 #ENV LSMB_MAIL_SMTPTLS
#ENV LSMB_MAIL_SMTPSENDER_HOSTNAME=(container hostname) #ENV LSMB_MAIL_SMTPUSER
#ENV LSMB_MAIL_SMTPTLS= #ENV LSMB_MAIL_SMTPPASS
#ENV LSMB_MAIL_SMTPUSER= #ENV LSMB_MAIL_SMTPAUTHMECH
#ENV LSMB_MAIL_SMTPPASS=
#ENV LSMB_MAIL_SMTPAUTHMECH=
## DATABASE ## DATABASE
ENV POSTGRES_HOST=postgres ENV POSTGRES_HOST postgres
ENV POSTGRES_PORT=5432 ENV POSTGRES_PORT 5432
ENV DEFAULT_DB=lsmb ENV DEFAULT_DB lsmb
COPY start.sh /usr/local/bin/start.sh COPY start.sh /usr/local/bin/start.sh
RUN chmod +x /usr/local/bin/start.sh && \ RUN chmod +x /usr/local/bin/start.sh && \
mkdir -p /var/www && \ mkdir -p /var/www
mkdir -p /srv/ledgersmb/local/conf && \
chown -R www-data /srv/ledgersmb/local
# Work around an aufs bug related to directory permissions: # Work around an aufs bug related to directory permissions:
RUN mkdir -p /tmp && chmod 1777 /tmp RUN mkdir -p /tmp && chmod 1777 /tmp

214
README.md
View File

@ -2,35 +2,17 @@
Dockerfile for LedgerSMB Docker image Dockerfile for LedgerSMB Docker image
## Content
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)
# Supported tags # Supported tags
- `1.12`, `1.12.x`, `latest` - Latest official release from the 1.12 branch - `1.8`, `1.8.x`, `latest` - Latest official release from the 1.8 branch
- `1.11`, `1.11.x` - Latest official release from the 1.11 branch - `1.7`, `1.7.x` - Latest official release from 1.7 branch
- `1.10`, `1.10.38` - Last official release from the 1.10 branch (End-of-Life) - `1.6`, `1.6.33` - Last official release from 1.6 branch
- `1.9`, `1.9.30` - Last official release from the 1.9 branch (End-of-Life) - `1.5`, `1.5.30` - Last official release from 1.5 branch
- `1.8`, `1.8.31` - Last official release from the 1.8 branch (End-of-Life) - `1.4`, `1.4.42` - Last official release from 1.4 branch
- `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 - `master` - Master branch from git, unstable
Containers supporting the development process are provided Containers supporting the development process are provided
through the ledgersmb-dev-docker project. See [the development through the [ledgersmb-dev-docker project](https://github.com/ledgersmb/ledgersmb-dev-docker/blob/master/README.md#getting-started).
container's README](https://github.com/ledgersmb/ledgersmb-dev-docker/blob/master/README.md#getting-started)
for more information.
# What is LedgerSMB? # What is LedgerSMB?
@ -63,37 +45,37 @@ could require additional setup of a mail service or CUPS printer service.
This image can be installed either automatically with the Docker compose file This image can be installed either automatically with the Docker compose file
or manually with docker only. or manually with docker only.
## Docker-Compose: Installation and start ## Docker-Compose installation and start
This repository provides a file named `docker-compose.yml` which can be used to This image provides `docker-compose.yml` which can be used to pull related
pull related images, install them, establish an internal network for their images, install them, establish an internal network for their communications,
communications, adjust environment variables, start and stop LedgerSMB. The adjust environment variables, start and stop LedgerSMB. The only instructions
only instructions required, after the optional edition of the file to adjust required, after the optional edition of the file to adjust the environment
the environment variables, are: variables, are:
```plain ```plain
$ docker-compose pull $ docker-compose pull
$ docker-compose up -d $ 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 This will set up two containers: (1) a PostgreSQL container with persistent
storage which is retained between container updates and (2) a LedgerSMB storage which is retained between container updates and (2) a LedgerSMB
container configured to connect to the PostgreSQL container as its database container configured to connect to the PostgreSQL container as its database
server. Your LedgerSMB installation should now be accessible through server. The containers will be running in the background and can be stopped
[http://localhost:5762/](http://localhost:5762/). and started by running:
The default number of workers is 5. The default database username and password ```plain
are: # 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:
```plain ```plain
username: postgres username: postgres
@ -101,7 +83,7 @@ are:
``` ```
From here, follow the steps as detailed in the instructions for From here, follow the steps as detailed in the instructions for
[preparing for first use](https://ledgersmb.org/content/preparing-ledgersmb-19-first-use). [preparing for first use](https://ledgersmb.org/content/preparing-ledgersmb-17-first-use).
## Manual installation ## Manual installation
@ -140,13 +122,9 @@ Visit http://localhost:5762/login.pl to log in and get started.
No persistant data is stored in the LedgerSMB container. No persistant data is stored in the LedgerSMB container.
All LedgerSMB data is stored in PostgreSQL, so you can stop/destroy/run a All LedgerSMB data is stored in Postgres, so you can stop/destroy/run a
new LedgerSMB container as often as you want. 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 # Environment Variables
The LedgerSMB image uses several environment variables. They are all optional. The LedgerSMB image uses several environment variables. They are all optional.
@ -182,6 +160,8 @@ affect the performance experience of users.
## Mail configuration ## Mail configuration
### 1.8.0 and higher
As of 1.8.0, the image is based on Debian Buster instead of Debian Stretch; 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 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 had to change strategy. The main application always came with built-in e-mail
@ -189,117 +169,36 @@ yet with the deprecation, the abilities have expanded.
The following parameters are now supported to set mail preferences: The following parameters are now supported to set mail preferences:
* `LSMB_MAIL_SMTPHOST` \ * `LSMB_MAIL_SMTPHOST`
The host name/IP-address of the SMTP server that will forward mail from * `LSMB_MAIL_SMTPPORT`
LedgerSMB to the outside world. * `LSMB_MAIL_SMTPTLS`
* `LSMB_MAIL_SMTPPORT` \ * `LSMB_MAIL_SMTPSENDER_HOSTNAME`
The port that the SMTP server in `LSMB_MAIL_SMTPHOST` listens to. * `LSMB_MAIL_SMTPUSER`
* `LSMB_MAIL_SMTPTLS` \ * `LSMB_MAIL_SMTPPASS`
Can be one of `no` (default), `yes` or `raw`. `yes` indicates to use * `LSMB_MAIL_SMTPAUTHMECH`
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 ### Before 1.8.0
The configuration file is stored in /srv/ledgersmb/local/conf/. By mounting These variables are used to set outgoing SMTP defaults.
that directory using a bind-mount to a location outside the container,
configuration can be changed between container starts:
```plain * `SSMTP_ROOT` (config: `Root` -- DEPRECATED)
$ docker run -d -p 5762:5762 --name myledger \ * `SSMTP_MAILHUB` (config: `Mailhub`)
--mount 'type=bind,src=/home/ledgersmb/conf,dst=/srv/ledgersmb/local/conf \ * `SSMTP_HOSTNAME` (config: `Hostname`)
-e POSTGRES_HOST=<ip/hostname> ledgersmb/ledgersmb:latest * `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)
## Overriding or adding configuration `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.
By pre-creating a configuration file in the mounted configuration directory, Use the other environment variables to relay mail through a different host.
the standard configuration generation process in the container can be overruled: Use the [ssmtp.conf man
page](https://www.systutorials.com/docs/linux/man/5-ssmtp.conf/) to look up
```plain the meaning and function of each of the mail configuration keys.
$ 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 # Troubleshooting/Developing
@ -316,8 +215,9 @@ 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). or through a [GitHub issue](https://github.com/ledgersmb/ledgersmb-docker/issues).
You can also reach some of the official LedgerSMB maintainers via the 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). `#ledgersmb` IRC channel on [Freenode](https://freenode.net), or on the
The [Element](https://app.element.io/#/room/#ledgersmb:matrix.org) Matrix client is highly recommended. 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 ## Contributing

View File

@ -1,36 +0,0 @@
# 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:

View File

@ -16,44 +16,28 @@ services:
# because that allows us to use the default hostname ("postgres") # because that allows us to use the default hostname ("postgres")
# from the LedgerSMB configuration # from the LedgerSMB configuration
postgres: postgres:
image: postgres:15-alpine image: postgres:9.6-alpine
environment: environment:
# Replace the password below for a secure setup # Replace the password below for a secure setup
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-abc} POSTGRES_PASSWORD: abc
PGDATA: /var/lib/postgresql/data/pgdata PGDATA: /var/lib/postgresql/data/pgdata
networks: networks:
- internal - internal
volumes: volumes:
- "pgdata:/var/lib/postgresql/data" - "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: lsmb:
depends_on: depends_on:
- postgres - postgres
image: ghcr.io/ledgersmb/ledgersmb:1.12 image: ledgersmb/ledgersmb:1.8
# 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: networks:
- internal - internal
- default - default
# Comment the 'ports' section to disable mapping the LedgerSMB container port (5762) # 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 # to the host's port of the same number, thus making LedgerSMB
# available on http://<host-dns-or-ip>:5762/ # available on http://<host-dns-or-ip>:5762/
# SECURITY NOTE: Leave this uncommented for evaluation purposes only! # SECURITY NOTE: Do this for evaluation purposes only!
# In production, be sure to use SSL/TLS (such as by reverse proxying) to protect # In production, be sure to use SSL/TLS to protect user's passwords
# user's passwords and other sensitive data # and other sensitive data
ports: ports:
- "5762:5762" - "5762:5762"
environment: environment:
@ -63,29 +47,17 @@ services:
# improve the performance experience, increase memory and the # improve the performance experience, increase memory and the
# number of workers # number of workers
# #
LSMB_WORKERS: ${LSMB_WORKERS:-5} LSMB_WORKERS: 2
# #
# #
# SSMTP_ROOT:
# LSMB_MAIL_SMTPHOST: # SSMTP_HOSTNAME:
# LSMB_MAIL_SMTPPORT: # SSMTP_MAILHUB:
# LSMB_MAIL_SMTPTLS: # SSMTP_AUTH_USER:
# LSMB_MAIL_SMTPSENDER_HOSTNAME: # SSMTP_AUTH_PASS:
# LSMB_MAIL_SMTPUSER: # SSMTP_AUTH_METHOD:
# LSMB_MAIL_SMTPPASS: # SSMTP_USE_STARTTLS:
# LSMB_MAIL_SMTPAUTHMECH: # 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
# 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 # having the dbdata volume is required to persist our
# data between PostgreSQL container updates; without # data between PostgreSQL container updates; without

View File

@ -1,81 +0,0 @@
# 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;
}
}
}

112
start.sh
View File

@ -1,7 +1,7 @@
#!/bin/bash #!/bin/bash
cd /srv/ledgersmb cd /srv/ledgersmb
[[ -d ./local/conf/ ]] || mkdir ./local/conf/
if [[ -n "$SSMTP_ROOT" ]]; then if [[ -n "$SSMTP_ROOT" ]]; then
echo "\$SSMTP_ROOT set; parameter is deprecated and will be ignored" echo "\$SSMTP_ROOT set; parameter is deprecated and will be ignored"
LSMB_HAVE_DEPRECATED=1 LSMB_HAVE_DEPRECATED=1
@ -67,94 +67,26 @@ if [[ -n "$LSMB_HAVE_DEPRECATED" ]]; then
echo "!!! DEPRECATED \$SSMTP_* PARAMETERS WILL BE REMOVED in the 1.9 image!!!" echo "!!! DEPRECATED \$SSMTP_* PARAMETERS WILL BE REMOVED in the 1.9 image!!!"
fi fi
if [[ ! -f ./local/conf/ledgersmb.yaml ]]; then
if [[ "x$LSMB_MAIL_SMTPTLS" == "xyes" ]]; then
tls_mode=starttls
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: if [[ ! -f ledgersmb.conf ]]; then
\$class: LedgerSMB::Database::Factory cat <<EOF >/tmp/ledgersmb.conf
connect_data: [main]
host: ${POSTGRES_HOST:-postgres} cache_templates = 1
port: ${POSTGRES_PORT:-5432} [database]
host = $POSTGRES_HOST
mail: port = $POSTGRES_PORT
transport: default_db = $DEFAULT_DB
\$class: Email::Sender::Transport::SMTP [mail]
ssl: $tls_mode ${LSMB_MAIL_SMTPHOST:+smtphost=$LSMB_MAIL_SMTPHOST
}${LSMB_MAIL_SMTPPORT:+smtpport=$LSMB_MAIL_SMTPPORT
miscellaneous: }${LSMB_MAIL_SMTPSENDER_HOSTNAME:+smtpsender_hostname=$LSMB_MAIL_SMTPSENDER_HOSTNAME
\$class: Beam::Wire }${LSMB_MAIL_SMTPTLS:+smtptls=$LSMB_MAIL_SMTPTLS
config: }${LSMB_MAIL_SMTPUSER:+smtpuser=$LSMB_MAIL_SMTPUSER
proxy_ip: ${PROXY_IP:-172.17.0.1/12} }${LSMB_MAIL_SMTPPASS:+smtppass=$LSMB_MAIL_SMTPPASS
}${LSMB_MAIL_SMTPAUTHMECH:+smtpauthmech=$LSMB_MAIL_SMTPAUTHMECH
ui: }
class: LedgerSMB::Template::UI
method: new_UI
lifecycle: eager
args:
cache:
\$ref: paths/UI_cache
root:
\$ref: paths/UI
EOF EOF
export LSMB_CONFIG_FILE='/tmp/ledgersmb.conf'
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 fi
# start ledgersmb # start ledgersmb
@ -162,14 +94,12 @@ fi
# starman instance (instead of just the worker, which will immediately # starman instance (instead of just the worker, which will immediately
# get restarted) on error; it also has a positive effect on memory use # 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' echo '--------- LEDGERSMB CONFIGURATION: ledgersmb.conf'
cat ${LSMB_CONFIG_FILE} cat ${LSMB_CONFIG_FILE:-ledgersmb.conf}
echo '--------- LEDGERSMB CONFIGURATION --- END' echo '--------- LEDGERSMB CONFIGURATION --- END'
# ':5762:' suppresses an uninitialized variable warning in starman # ':5762:' suppresses an uninitialized variable warning in starman
# the last colon means "don't connect using tls"; without it, there's a warning # 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} \ exec starman --listen :5762: --max-workers ${LSMB_WORKERS:-5} \
-I lib -I old/lib \ -I lib -I old/lib \
--preload-app bin/ledgersmb-server.psgi --preload-app bin/ledgersmb-server.psgi