mirror of
https://github.com/ledgersmb/ledgersmb-docker.git
synced 2025-04-20 07:07:10 -04:00
Compare commits
33 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
3658a14ccd | ||
|
f114db8fcb | ||
|
2849671500 | ||
|
bdebd44ae0 | ||
|
c95e4b4b9d | ||
|
7c89b26987 | ||
|
cd7f62abc6 | ||
|
d518733d23 | ||
|
53c4e6ac92 | ||
|
78b902ddc9 | ||
|
c1fee69d52 | ||
|
33d4019521 | ||
|
2a138c50f2 | ||
|
11baa4c0a0 | ||
|
7e914dbfd1 | ||
|
1a1d294e31 | ||
|
44b544c8ba | ||
|
5dc7176b3f | ||
|
f25dee9473 | ||
|
0332a27535 | ||
|
19c6b2d6df | ||
|
6ff37dc952 | ||
|
da234d021d | ||
|
ffb7ff1a09 | ||
|
966c1fd043 | ||
|
ba98f4c5c0 | ||
|
20bd26798a | ||
|
f4bc2c874f | ||
|
0897045096 | ||
|
53ab84cbaa | ||
|
760c5c0138 | ||
|
8930ac395d | ||
|
1bbf65543b |
10
Dockerfile
10
Dockerfile
@ -2,8 +2,9 @@ FROM debian:stretch-slim
|
||||
MAINTAINER Freelock john@freelock.com
|
||||
|
||||
# Build time variables
|
||||
ARG LSMB_VERSION="1.7.9"
|
||||
ARG LSMB_VERSION="1.7.33"
|
||||
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...
|
||||
@ -21,7 +22,8 @@ ARG LSMB_DL_DIR="Releases"
|
||||
# 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 && \
|
||||
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/ && \
|
||||
@ -54,7 +56,7 @@ RUN echo -n "APT::Install-Recommends \"0\";\nAPT::Install-Suggests \"0\";\n" >>
|
||||
libtemplate-plugin-latex-perl libtex-encode-perl \
|
||||
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 \
|
||||
@ -65,7 +67,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 \
|
||||
|
88
README.md
88
README.md
@ -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
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user