mirror of
https://github.com/ledgersmb/ledgersmb-docker.git
synced 2025-10-14 00:00:29 -04:00
Compare commits
125 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
b12fdd9770 | ||
|
fe44578c0f | ||
|
e77dae7d1c | ||
|
74128eef35 | ||
|
a7326af5fa | ||
|
fbe602af1c | ||
|
40107716c8 | ||
|
3c129424dc | ||
|
8a6d7e2252 | ||
|
1979f70541 | ||
|
f1411898b4 | ||
|
80702acab4 | ||
|
6659f8f8ae | ||
|
59df4ddefd | ||
|
b02d6b1044 | ||
|
1f9e54cbe8 | ||
|
955812f36b | ||
|
4f5f8e8cbf | ||
|
b7502825f1 | ||
|
3d73729575 | ||
|
f9aeeaad75 | ||
|
f7f7ecf3a1 | ||
|
4772312182 | ||
|
c5c6011073 | ||
|
db941843fb | ||
|
ae687da108 | ||
|
6bc115c7e6 | ||
|
d7bf3b30a0 | ||
|
8d6e8fe95b | ||
|
3156651671 | ||
|
0205b40bd2 | ||
|
84130b47f3 | ||
|
d27017e309 | ||
|
f3420feb36 | ||
|
82445543de | ||
|
99a21f8e7d | ||
|
74aa2920da | ||
|
821d59fb79 | ||
|
409aeefd56 | ||
|
2608ff28bb | ||
|
9adee2d1ba | ||
|
89f9f5e449 | ||
|
77a6985f29 | ||
|
f2a0c60b94 | ||
|
b9c316569d | ||
|
907fc363af | ||
|
40ab4edab4 | ||
|
dd6c18c5a6 | ||
|
fe2ae210a2 | ||
|
f8ef55726d | ||
|
05b8961242 | ||
|
385dd60c3f | ||
|
001e98ed38 | ||
|
1eb854f2d6 | ||
|
878111e7cd | ||
|
18980a353f | ||
|
46637422ee | ||
|
ba202372fa | ||
|
3197f4feab | ||
|
46a5386e54 | ||
|
6122921674 | ||
|
db957f3880 | ||
|
7e059e5dc1 | ||
|
421c153249 | ||
|
1f40452e92 | ||
|
98c38f998a | ||
|
6d3b30720c | ||
|
aa66d87e15 | ||
|
e06638b048 | ||
|
d71609cae1 | ||
|
8bc4fd8583 | ||
|
52fdf5b65e | ||
|
29abd11efd | ||
|
e9edcaf9ae | ||
|
3a74802fe1 | ||
|
1b9701511e | ||
|
1ff4cc42c3 | ||
|
26b679fe7d | ||
|
82e2dd4839 | ||
|
4cb2cad5c1 | ||
|
c5c0575c94 | ||
|
b4ed837573 | ||
|
fae1cd333e | ||
|
75f3dfd642 | ||
|
5afb58f246 | ||
|
a5d89bc9fe | ||
|
b8795c4811 | ||
|
b828cffad3 | ||
|
36bc6d5ffc | ||
|
59be4f4afa | ||
|
f898c2bb63 | ||
|
c2573f6a7e | ||
|
38ab58e93a | ||
|
d45d0a7182 | ||
|
d640f5e6a0 | ||
|
d7c3bd6038 | ||
|
9c2c5a20c6 | ||
|
ebb6a521ef | ||
|
058848a29a | ||
|
a0053b33b6 | ||
|
a5ca6aa894 | ||
|
c616d6f8ab | ||
|
f69a36a5d3 | ||
|
dbed029289 | ||
|
dfa82a63bf | ||
|
9353e8187f | ||
|
a1ea9d9895 | ||
|
0f8af754bd | ||
|
da48259b68 | ||
|
774e6ef6e2 | ||
|
0d8517ebc4 | ||
|
f7cfcc72ec | ||
|
847efed2d0 | ||
|
9d5b62b6bb | ||
|
e23e85fea8 | ||
|
c4a1a6f1cc | ||
|
90764650c5 | ||
|
795fdf3f95 | ||
|
6cceef46f6 | ||
|
e29aa14d57 | ||
|
a22ed7ac49 | ||
|
1f1df000b8 | ||
|
fe867c9925 | ||
|
9ff64318ab | ||
|
46ae598da0 |
9
.github/no-response.yml
vendored
Normal file
9
.github/no-response.yml
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
# 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.
|
158
Dockerfile
158
Dockerfile
@@ -1,55 +1,100 @@
|
||||
FROM debian:jessie
|
||||
# Build time variables
|
||||
|
||||
ARG SRCIMAGE=debian:buster-slim
|
||||
|
||||
|
||||
FROM $SRCIMAGE AS builder
|
||||
|
||||
ARG LSMB_VERSION="1.8.27"
|
||||
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
|
||||
|
||||
RUN echo -n "APT::Install-Recommends \"0\";\nAPT::Install-Suggests \"0\";\n" >> /etc/apt/apt.conf
|
||||
# Build time variables
|
||||
ARG LSMB_VERSION="1.8.27"
|
||||
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...
|
||||
RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
|
||||
apt-get dist-upgrade -y && apt-get -y install \
|
||||
libcgi-emulate-psgi-perl libcgi-simple-perl libconfig-inifiles-perl \
|
||||
libdbd-pg-perl libdbi-perl libdatetime-perl \
|
||||
libdatetime-format-strptime-perl libdigest-md5-perl \
|
||||
libfile-mimeinfo-perl libjson-xs-perl libjson-perl \
|
||||
liblocale-maketext-perl liblocale-maketext-lexicon-perl \
|
||||
liblog-log4perl-perl libmime-base64-perl libmime-lite-perl \
|
||||
libmath-bigint-gmp-perl libmoose-perl libnumber-format-perl \
|
||||
libpgobject-perl libpgobject-simple-perl libpgobject-simple-role-perl \
|
||||
libpgobject-util-dbmethod-perl libplack-perl libtemplate-perl \
|
||||
libnamespace-autoclean-perl \
|
||||
libtemplate-plugin-latex-perl libtex-encode-perl \
|
||||
libmoosex-nonmoose-perl libclass-c3-xs-perl \
|
||||
texlive-latex-recommended \
|
||||
texlive-xetex \
|
||||
starman \
|
||||
libopenoffice-oodoc-perl \
|
||||
postgresql-client \
|
||||
ssmtp \
|
||||
lsb-release \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# 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
|
||||
# Install Locale::Codes Locale::Country Locale::Language from CPAN to suppress
|
||||
# deprecation-as-core-module warning
|
||||
|
||||
# Build time variables
|
||||
ENV LSMB_VERSION 1.5.11
|
||||
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/ && \
|
||||
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 -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-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 && \
|
||||
(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 -q -y install git cpanminus make gcc libperl-dev && \
|
||||
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 \
|
||||
--with-feature=openoffice \
|
||||
--installdeps /srv/ledgersmb/ && \
|
||||
apt-get purge -q -y git cpanminus make gcc libperl-dev && \
|
||||
apt-get autoremove -q -y && \
|
||||
apt-get clean -q && \
|
||||
rm -rf ~/.cpanm/ /var/lib/apt/lists/* /usr/share/man/*
|
||||
|
||||
# Install LedgerSMB
|
||||
RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
|
||||
apt-get -y install git cpanminus make gcc libperl-dev && \
|
||||
cd /srv && \
|
||||
curl -Lo ledgersmb-$LSMB_VERSION.tar.gz "http://download.ledgersmb.org/f/Releases/$LSMB_VERSION/ledgersmb-$LSMB_VERSION.tar.gz" && \
|
||||
tar -xvzf ledgersmb-$LSMB_VERSION.tar.gz && \
|
||||
rm -f ledgersmb-$LSMB_VERSION.tar.gz && \
|
||||
cd ledgersmb && \
|
||||
cpanm --quiet --notest \
|
||||
--with-feature=starman \
|
||||
--with-feature=latex-pdf-ps \
|
||||
--with-feature=openoffice \
|
||||
--installdeps . && \
|
||||
apt-get purge -y git cpanminus make gcc libperl-dev && \
|
||||
apt-get autoremove -y && \
|
||||
apt-get autoclean && \
|
||||
rm -rf ~/.cpanm/ && \
|
||||
rm -rf /var/lib/apt/lists/*
|
||||
|
||||
WORKDIR /srv/ledgersmb
|
||||
|
||||
@@ -57,30 +102,27 @@ WORKDIR /srv/ledgersmb
|
||||
|
||||
# Configure outgoing mail to use host, other run time variable defaults
|
||||
|
||||
## sSMTP
|
||||
ENV SSMTP_ROOT ar@example.com
|
||||
ENV SSMTP_MAILHUB 172.17.0.1
|
||||
ENV SSMTP_HOSTNAME 172.17.0.1
|
||||
#ENV SSMTP_USE_STARTTLS
|
||||
#ENV SSMTP_AUTH_USER
|
||||
#ENV SSMTP_AUTH_PASS
|
||||
ENV SSMTP_FROMLINE_OVERRIDE YES
|
||||
#ENV SSMTP_AUTH_METHOD
|
||||
## MAIL
|
||||
ENV LSMB_MAIL_SMTPHOST 172.17.0.1
|
||||
#ENV LSMB_MAIL_SMTPPORT 25
|
||||
#ENV LSMB_MAIL_SMTPSENDER_HOSTNAME (container hostname)
|
||||
#ENV LSMB_MAIL_SMTPTLS
|
||||
#ENV LSMB_MAIL_SMTPUSER
|
||||
#ENV LSMB_MAIL_SMTPPASS
|
||||
#ENV LSMB_MAIL_SMTPAUTHMECH
|
||||
|
||||
## DATABASE
|
||||
ENV POSTGRES_HOST postgres
|
||||
ENV POSTGRES_PORT 5432
|
||||
ENV DEFAULT_DB lsmb
|
||||
|
||||
COPY start.sh /usr/local/bin/start.sh
|
||||
COPY update_ssmtp.sh /usr/local/bin/update_ssmtp.sh
|
||||
|
||||
RUN chown www-data /etc/ssmtp /etc/ssmtp/ssmtp.conf && \
|
||||
chmod +x /usr/local/bin/update_ssmtp.sh /usr/local/bin/start.sh && \
|
||||
RUN chmod +x /usr/local/bin/start.sh && \
|
||||
mkdir -p /var/www
|
||||
|
||||
# Work around an aufs bug related to directory permissions:
|
||||
RUN mkdir -p /tmp && \
|
||||
chmod 1777 /tmp
|
||||
RUN mkdir -p /tmp && chmod 1777 /tmp
|
||||
|
||||
# Internal Port Expose
|
||||
EXPOSE 5762
|
||||
|
225
README.md
225
README.md
@@ -1,112 +1,227 @@
|
||||
# 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.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
|
||||
- `1.8`, `1.8.x`, `latest` - 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).
|
||||
|
||||
# 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 recommend not 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 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
|
||||
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.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start a postgres instance
|
||||
This image can be installed either automatically with the Docker compose file
|
||||
or manually with docker only.
|
||||
|
||||
docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d postgres
|
||||
## Docker-Compose installation and start
|
||||
|
||||
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`.
|
||||
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:
|
||||
|
||||
> 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)
|
||||
```plain
|
||||
$ docker-compose pull
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
## Start LedgerSMB
|
||||
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:
|
||||
|
||||
docker run --name myledger --link some-postgres:postgres -d ledgersmb/ledgersmb
|
||||
```plain
|
||||
# Stopping the containers
|
||||
$ docker-compose stop
|
||||
|
||||
## Set up LedgerSMB
|
||||
# Starting the containers
|
||||
$ docker-compose start
|
||||
```
|
||||
|
||||
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)
|
||||
(Check the status of the containers using `docker-compose ps`; when the
|
||||
containers are running, the `State` column shows `Up`.)
|
||||
|
||||
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.
|
||||
The database username and password are:
|
||||
|
||||
Once you have completed the setup, you have a fully functional LedgerSMB instance running!
|
||||
```plain
|
||||
username: postgres
|
||||
password: abc
|
||||
```
|
||||
|
||||
Visit http://myledger:5762/login.pl to log in and get started.
|
||||
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
|
||||
|
||||
```plain
|
||||
$ docker run -d -p 5762:5762 --name myledger \
|
||||
-e POSTGRES_HOST=<ip/hostname> 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 and http://localhost:5762/login.pl.
|
||||
|
||||
Below are more variables which determine container configuration,
|
||||
like `POSTGRES_HOST` above.
|
||||
|
||||
# Set up LedgerSMB
|
||||
|
||||
* Visit http://myledger:5762/setup.pl.
|
||||
* Log in with the "postgres" user and the password `abc` as given above -
|
||||
or with the credentials of your own database server in case of a manual
|
||||
setup - and provide the name of a company (= database name) you want to
|
||||
create.
|
||||
* Go over the steps presented in the browser
|
||||
|
||||
Once you have completed the setup steps, you have a fully functional
|
||||
LedgerSMB instance running!
|
||||
|
||||
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
|
||||
|
||||
### 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
|
||||
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`
|
||||
|
||||
|
||||
### Before 1.8.0
|
||||
|
||||
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` -- 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
|
||||
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).
|
||||
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
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
You are invited to contribute new features, fixes, or updates, large or small;
|
||||
we are always thrilled to receive pull requests, and do our best to process
|
||||
them as fast as we can.
|
||||
|
80
docker-compose.yml
Normal file
80
docker-compose.yml
Normal file
@@ -0,0 +1,80 @@
|
||||
# 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: ghcr.io/ledgersmb/ledgersmb:1.8
|
||||
networks:
|
||||
- internal
|
||||
- default
|
||||
# Comment the 'ports' section to disable mapping 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
|
||||
#
|
||||
#
|
||||
# LSMB_MAIL_SMTPHOST:
|
||||
# LSMB_MAIL_SMTPPORT:
|
||||
# LSMB_MAIL_SMTPTLS:
|
||||
# LSMB_MAIL_SMTPSENDER_HOSTNAME:
|
||||
# LSMB_MAIL_SMTPUSER:
|
||||
# LSMB_MAIL_SMTPPASS:
|
||||
# LSMB_MAIL_SMTPAUTHMECH:
|
||||
#
|
||||
#
|
||||
# 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
|
||||
# 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:
|
115
start.sh
115
start.sh
@@ -1,48 +1,107 @@
|
||||
#!/bin/bash
|
||||
|
||||
update_ssmtp.sh
|
||||
cd /srv/ledgersmb
|
||||
|
||||
if [[ -n "$SSMTP_ROOT" ]]; then
|
||||
echo "\$SSMTP_ROOT set; parameter is deprecated and will be ignored"
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
if [[ -n "$SSMTP_FROMLINE_OVERRIDE" ]]; then
|
||||
echo "\$SSMTP_FROMLINE_OVERRIDE set; parameter is deprecated and will be ignored"
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
if [[ -n "$SSMTP_MAILHUB" ]]; then
|
||||
echo "\$SSMTP_MAILHUB set; parameter is deprecated"
|
||||
if [[ -z "$LSMB_MAIL_SMTPHOST" ]]; then
|
||||
echo " Deriving \$LSMB_MAIL_SMTPHOST setting from \$SSMTP_MAILHUB"
|
||||
LSMB_MAIL_SMTPHOST=${SSMTP_MAILHUB%:*}
|
||||
fi
|
||||
if [[ -z "$LSMB_MAIL_SMTPPORT" ]]; then
|
||||
echo " Deriving \$LSMB_MAIL_SMTPPORT setting from \$SSMTP_MAILHUB"
|
||||
LSMB_MAIL_SMTPPORT=${SSMTP_MAILHUB#*:}
|
||||
fi
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
if [[ -n "$SSMTP_HOSTNAME" ]]; then
|
||||
echo "\$SSMTP_HOSTNAME set; parameter is deprecated"
|
||||
if [[ -z "$LSMB_MAIL_SMTPSENDER_HOSTNAME" ]]; then
|
||||
echo " Deriving \$LSMB_MAIL_SMTPSENDER_HOSTNAME setting from \$SSMTP_HOSTNAME"
|
||||
LSMB_MAIL_SMTPSENDER_HOSTNAME=$SSMTP_HOSTNAME
|
||||
fi
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
if [[ -n "$SSMTP_USE_STARTTLS" ]]; then
|
||||
echo "\$SSMTP_USE_STARTTLS set; parameter is deprecated"
|
||||
if [[ -z "$LSMB_MAIL_SMTPTLS" ]]; then
|
||||
echo " Deriving \$LSMB_MAIL_SMTPSENDER_HOSTNAME setting from \$SSMTP_USE_STARTTLS"
|
||||
LSMB_MAIL_SMTPTLS=$SSMTP_USE_STARTTLS
|
||||
fi
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
if [[ -n "$SSMTP_AUTH_USER" ]]; then
|
||||
echo "\$SSMTP_AUTH_USER set; parameter is deprecated"
|
||||
if [[ -z "$LSMB_MAIL_SMTPUSER" ]]; then
|
||||
echo " Deriving \$LSMB_MAIL_SMTPUSER setting from \$SSMTP_AUTH_USER"
|
||||
LSMB_MAIL_SMTPUSER=$SSMTP_AUTH_USER
|
||||
fi
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
if [[ -n "$SSMTP_AUTH_PASS" ]]; then
|
||||
echo "\$SSMTP_AUTH_PASS set; parameter is deprecated"
|
||||
if [[ -z "$LSMB_MAIL_SMTPPASS" ]]; then
|
||||
echo " Deriving \$LSMB_MAIL_SMTPPASS setting from \$SSMTP_AUTH_PASS"
|
||||
LSMB_MAIL_SMTPPASS=$SSMTP_AUTH_PASS
|
||||
fi
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
if [[ -n "$SSMTP_AUTH_METHOD" ]]; then
|
||||
echo "\$SSMTP_AUTH_METHOD set; parameter is deprecated"
|
||||
if [[ -z "$LSMB_MAIL_SMTPAUTHMECH" ]]; then
|
||||
echo " Deriving \$LSMB_MAIL_SMTPAUTHMECH setting from \$SSMTP_AUTH_METHOD"
|
||||
LSMB_MAIL_SMTPAUTHMECH=$SSMTP_AUTH_METHOD
|
||||
fi
|
||||
LSMB_HAVE_DEPRECATED=1
|
||||
fi
|
||||
|
||||
if [[ -n "$LSMB_HAVE_DEPRECATED" ]]; then
|
||||
echo "!!! DEPRECATED \$SSMTP_* PARAMETERS WILL BE REMOVED in the 1.9 image!!!"
|
||||
fi
|
||||
|
||||
|
||||
if [[ ! -f ledgersmb.conf ]]; then
|
||||
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
|
||||
|
||||
${LSMB_MAIL_SMTPHOST:+smtphost=$LSMB_MAIL_SMTPHOST
|
||||
}${LSMB_MAIL_SMTPPORT:+smtpport=$LSMB_MAIL_SMTPPORT
|
||||
}${LSMB_MAIL_SMTPSENDER_HOSTNAME:+smtpsender_hostname=$LSMB_MAIL_SMTPSENDER_HOSTNAME
|
||||
}${LSMB_MAIL_SMTPTLS:+smtptls=$LSMB_MAIL_SMTPTLS
|
||||
}${LSMB_MAIL_SMTPUSER:+smtpuser=$LSMB_MAIL_SMTPUSER
|
||||
}${LSMB_MAIL_SMTPPASS:+smtppass=$LSMB_MAIL_SMTPPASS
|
||||
}${LSMB_MAIL_SMTPAUTHMECH:+smtpauthmech=$LSMB_MAIL_SMTPAUTHMECH
|
||||
}
|
||||
[proxy]
|
||||
ip=${PROXY_IP:-172.17.0.1/12}
|
||||
EOF
|
||||
export LSMB_CONFIG_FILE='/tmp/ledgersmb.conf'
|
||||
fi
|
||||
|
||||
if [ ! -f "/tmp/ledgersmb" ]; then
|
||||
mkdir /tmp/ledgersmb
|
||||
fi
|
||||
# Currently unmaintained/untested
|
||||
# if [ ! -z ${CREATE_DATABASE+x} ]; then
|
||||
# perl tools/dbsetup.pl --company $CREATE_DATABASE \
|
||||
# --host $POSTGRES_HOST \
|
||||
# --postgres_password "$POSTGRES_PASS"
|
||||
#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";
|
||||
echo -e "\tmaybe: $PerlLib";
|
||||
}
|
||||
done ;
|
||||
echo "Selected PERL5LIB=$PERL5LIB";
|
||||
|
||||
# start ledgersmb
|
||||
# --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
|
||||
# get restarted) on error; it also has a positive effect on memory use
|
||||
|
||||
echo '--------- LEDGERSMB CONFIGURATION: ledgersmb.conf'
|
||||
cat ${LSMB_CONFIG_FILE:-ledgersmb.conf}
|
||||
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} \
|
||||
-I lib -I old/lib \
|
||||
--preload-app bin/ledgersmb-server.psgi
|
||||
|
@@ -1,18 +0,0 @@
|
||||
#!/bin/bash
|
||||
ConfiguredComment='# install script update_ssmtp.sh has configured ssmtp'
|
||||
grep -qc "$ConfiguredComment" /etc/ssmtp/ssmtp.conf && {
|
||||
echo "smtp configured."
|
||||
exit
|
||||
}
|
||||
|
||||
sed -i \
|
||||
-e "s/\(root=\).*\$/\1$SSMTP_ROOT/g" \
|
||||
-e "s/\(mailhub=\).*\$/\1$SSMTP_MAILHUB/g" \
|
||||
-e "s/\(hostname=\).*\$/\1$SSMTP_HOSTNAME/g" \
|
||||
/etc/ssmtp/ssmtp.conf
|
||||
[ -z "$SSMTP_USE_STARTTLS" ] || echo "UseSTARTTLS=$SSMTP_USE_STARTTLS" >> /etc/ssmtp/ssmtp.conf
|
||||
[ -z "$SSMTP_AUTH_USER" ] || echo "AuthUser=$SSMTP_AUTH_USER" >> /etc/ssmtp/ssmtp.conf
|
||||
[ -z "$SSMTP_AUTH_PASS" ] || echo "AuthPass=$SSMTP_AUTH_PASS" >> /etc/ssmtp/ssmtp.conf
|
||||
[ -z "$SSMTP_AUTH_METHOD" ] || echo "AuthMethod=$SSMTP_AUTH_METHOD" >> /etc/ssmtp/ssmtp.conf
|
||||
[ -z "$SSMTP_FROMLINE_OVERRIDE" ] || echo "FromLineOverride=$SSMTP_FROMLINE_OVERRIDE" >> /etc/ssmtp/ssmtp.conf
|
||||
echo "$ConfiguredComment" >> /etc/ssmtp/ssmtp.conf
|
Reference in New Issue
Block a user