Dockerfile for LedgerSMB Docker image
latest- Latest release tarball from 1.5 branch
1.4.x- Latest tagged release of git 1.4 branch
master- Master branch from git, unstable
1.5-dev- Containers to kick off a development setup
What is LedgerSMB?
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 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
- The Starman author recommends it
- 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.
The quickest way to get this image up and running is by using the
docker-compose file available through the GitHub repository at:
which sets up both this image and a supporting database image for
production purposes (i.e. with persistent (database) data, with the
exception of one thing: setting up an Nginx or Apache reverse proxy
with TLS 1.2 support -- a requirement if you want to access your
installation over any type of network.
How to use this image
Start a postgres instance
$ docker run -d --name postgres \ -e POSTGRES_PASSWORD=mysecretpassword \ postgres:latest
BEWARE: The command above creates a container with the database data stored
inside the container. Upon removal of the container, the database data will
be removed too!
To prevent destruction of the database data upon replacement of the container,
please use these commands instead:
$ docker volume create dbdata $ docker run -d --name postgres \ -e POSTGRES_PASSWORD=mysecretpassword \ -e PGDATA=/var/lib/postgresql/data/pgdata \ -v dbdata:/var/lib/postgresql/data \ postgres:latest
$ docker run -d -p 5762:5762 --name myledger \ 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
Set up LedgerSMB
- Visit http://myledger:5762/setup.pl.
- Log in with the "postgres" user and the password
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 as often as you want.
The LedgerSMB image uses several environment variables. They are all optional.
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 on which the PostgreSQL server is running.
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.
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.
The docker image uses
ssmtp to send mail.
These variables are used to set outgoing SMTP defaults.
To set the outgoing email address, set
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 to look up
the meaning and function of each of the mail configuration keys.
Currently the LedgerSMB installation is in /srv/ledgersmb
and the startup & config script is /usr/bin/start.sh.
You can also reach some of the official LedgerSMB maintainers via the
#ledgersmb IRC channel on Freenode, or on the bridged Matrix room in #ledgersmb:matrix.org. The Riot.im Matrix client is highly recommended.
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.