LedgerSMB - Small and Medium business accounting and ERP
LedgerSMB is a free integrated web application accounting system, featuring double entry accounting, budgetting, invoicing, quotations, projects, timecards, inventory management, shipping and more ...
The UI allows world-wide accessibility; with its data stored in the enterprise-strength PostgreSQL open source database system, the system is know to operate smoothly for businesses with thousands of transactions per week. Screens and customer visible output are defined in templates, allowing easy and fast customization. Supported output formats are PDF, CSV, HTML, ODF and more.
Directly send orders and invoices from the built-in e-mail function to your customers or RFQs (request for quotation) to your vendors with PDF attachments.
- Perl 5.10+
- PostgreSQL 9.4+
- Web server (e.g. nginx, Apache, lighttpd)
The web external server is only required for production installs; for evaluation purposes a simpler setup can be used, as detailed below.
A Dojo 1.10 compatible web browser is all that's required on the client (except IE8 and 9); it includes Chrome as of version 13, FireFox as of 3.6 and MS Internet Explorer as of version 10 and a wide range of mobile browsers.
Quick start (Docker compose)
The quickest way to get the Docker image up and running is by using the docker-compose file available through the GitHub repository at:
which sets up both the LedgerSMB 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.
See the documentation on Docker Hub.
Quick start (from source)
Check out the sources from GitHub
Note: Skip this step for from-tarball installs Installation from release tarballs is preferred over installation from GitHub.
To get the latest development version:
$ git clone https://github.com/ledgersmb/LedgerSMB.git $ cd LedgerSMB $ git submodule update --init --recursive
To get the released version 1.4.22, the commands look like:
$ git clone -b 1.4.22 https://github.com/ledgersmb/LedgerSMB.git $ cd LedgerSMB $ git submodule update --init --recursive
System (library) dependencies
The following non-Perl (system) dependencies need to be in place for the
cpanm command mentioned below to work, in addition to what's documented
on the How to install CPAN modules
page on CPAN.
- cpanminus This can be manually installed, or installed as a system package. It may not be necessary to install cpanminus if you are only going to install from debian packages.
- PostgreSQL client libraries
- PostgreSQL server
- DBD::Pg 3.4.2+ (so cpanm recognises that it won't need to compile it)
This package is called
libdbd-pg-perlin Debian and
- make This is used by cpan dependencies during thier build process
Then, some of the features listed below have system requirements as well:
- latex-pdf-ps depends on these binaries or libraries:
- latex (usually provided through a texlive package)
Perl module dependencies
This section depends on a working local::lib installation
as well as an installed
cpanm executable. Both should be available from
your distribution's package repository (Debian calls them
cpanm depends on the
gcc commands being available.
local::lib is installed from the the distro repository,
step (4) in the installation instructions
is still to be executed:
NOTE: gcc can be removed after all cpan dependencies are installed. However, it may be necessary to reinstall it if additional modules are required during an upgrade
$ echo 'eval "$(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)"' >>~/.bashrc
In order for the command above to take effect, please log out and log in again.
To install the Perl module dependencies, run:
$ cpanm --quiet --notest --with-feature=starman [other features] --installdeps .
NOTE: Don't miss the "." at the end of the cpanm command!
Don't forget to make sure the environment variable
PERL5LIB=/home/ledgersmb/perl5/lib/perl5 points at the running user's perl5 dir
Also, NEVER run cpanm as root, it's best to run it as the user you intend to run ledgersmb as when possible.
This installs the cpan modules in
If you can't run it as the final user, don't worry, just run it as any user (eg: johnny),
and make sure the environment variable
PERL5LIB=/home/johhny/perl5/lib/perl5 points at jonny's perl5 dir
PERL5 environment variable is normally done by editing the initscript, or systemd service file.
If you are running manually, then you will need to set and export
PERL5 before running starman/plack
The following features may be selected by
|latex-pdf-ps||Enable PDF and PostScript output|
|latex-pdf-images||Image size detection for PDF output|
|starman||Starman Perl/PSGI webserver|
|openoffice||OpenOffice.org document output|
|edi||(EXPERIMENTAL) X12 EDI support|
|rest||(EXPERIMENTAL) RESTful webservices|
Note: The example command contains
--with-feature=starman for the
purpose of the quick start.
cpanm will by default use local::lib so that dependencies are not installed into the global perl installation.
The in-depth installation instructions contain a list of distribution provided packages to reduce the CPAN installation.
- For the pdf-ps target, LaTeX is required.
- For the pdf-images target, ImageMagick is required.
While it's possible to use LedgerSMB with the standard
it's good practice to create a separate 'LedgerSMB database administrator':
$ sudo -u postgres createuser --no-superuser --createdb --login \ --createrole --pwprompt lsmb_dbadmin Enter password for new role: **** Enter it again: ****
pg_hba.conf file should have at least these lines in it (order of the entries matters):
local all postgres peer local all all peer host all postgres 127.0.0.1/32 reject host all postgres ::1/128 reject host postgres,template0,template1 lsmb_dbadmin 127.0.0.1/32 md5 host postgres,template0,template1 lsmb_dbadmin ::1/128 md5 host postgres,template0,template1 all 127.0.0.1/32 reject host postgres,template0,template1 all ::1/128 reject host all all 127.0.0.1/32 md5 host all all ::1/128 md5
pg_hba.confcan be found in
/etc/postgresql/<version>/main/on Debian and in
After editing the
pg_hba.conf file, reload the PostgreSQL server
(or without 'sudo' by running the commands as root user):
$ sudo service postgresql reload # -or- $ sudo /etc/init.d/postgresql reload
For most systems, all that's required in this step is:
$ cp conf/ledgersmb.conf.unbuilt-dojo ledgersmb.conf
Note: Using 'built dojo' instead of 'unbuilt dojo' will greatly improve page load times of some pages. However, creating a built dojo adds considerable complexity to these instructions; please consult the extensive setup instructions to build dojo.
With the above steps completed, the system is ready to run the web server:
NOTE: DO NOT run starman (or any web service) as root, this is considered a serious security issue, and as such LedgerSMB doesn't support it. Instead, if you need to start LedgerSMB from a root process, drop privlidges to a user that doesn't have write access to the LedgerSMB Directories first. Most daemonising mechanisims (eg: systemd) provide a mechanism to do this. Do not use the starman --user= mechanism, it currently drops privlidges too late.
$ starman -I lib --listen localhost:5762 tools/starman.psgi 2016/05/12-02:14:57 Starman::Server (type Net::Server::PreFork) starting! pid(xxxx) Resolved [*]:5762 to [::]:5762, IPv6 Not including resolved host [0.0.0.0] IPv4 because it will be handled by [::] IPv6 Binding to TCP port 5762 on host :: with IPv6 Setting gid to "1000 1000 24 25 27 29 30 44 46 108 111 121 1000"
We support the following
- PERL5LIB : Required for most installations (if local::lib has been used)
- should be already be configured as part of Section Perl module dpendencies
- LSMB_WORKINGDIR : Optional
- Causes a chdir to the specified directory as the first thing done in starman.psgi
- If not set the current dir is used.
- An example would be
The system is installed and should be available for evaluation through
- http://localhost:5762/setup.pl # creation and privileged management of company databases
- http://localhost:5762/login.pl # Normal login for the application
The system is ready for preparation for first use.
Web site: http://ledgersmb.org/
- IRC: irc://irc.freenode.net/#ledgersmb
- Matrix: https://vector.im/#/room/#ledgersmb:matrix.org (bridged IRC channel)
Mailing list archives: http://archive.ledgersmb.org
Source code contributors can be found in the project's Git commit history as well as in the CONTRIBUTORS file in the repository root.
Translation contributions can be found in the project's Git commit history as well as in the Transifex project Timeline.
Copyright (c) 2006 - 2016 The LedgerSMB Project contributors Copyright (c) 1999 - 2006 DWS Systems Inc (under the name SQL Ledger)