E Deprecated Content

E.1 ledgersmb.conf

This ledgersmb.conf is deprecated as of 1 Jan 2023 and only remains here for historical use.

The environment variable for controlling the configuration is LSMB_CONFIG_FILE.

By default it pointed to /etc/ledgersmb/ledgersmb.conf and can be set to an alternate location.

[main] Section

language

Set language for login and admin pages.

date_format

Set the date format for the admin pages. The default is yyyy-mm-dd. Unset means detected from the browser)

log_level

Specifies the logging level to be used. This setting is ignored when the log_config setting is supplied and indicates an existing file. Available values are OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE.

log_config

Set the name of the extended logging configuration file. This file uses the log4j/Log::Log4perl syntax described at https://metacpan.org/pod/Log::Log4perl#Configuration-files

dojo_theme

This is the Dojo theme that is used by default when no other theme has been selected. The default if unset is claro. Other values can be nihilo, soria, and tundra.

auth

Indicates which authentication module is to be used; default is DB, referring to LedgerSMB::Auth::DB.

cache_templates

Determines if HTML templates used for the LedgerSMB UI will be stored in precompiled form for improved performance. The value 0 (zero) means no caching; the value 1 means caching in the directory $(tempdir)/lsmb_templates; systems running multiple LedgerSMB instances with customized UIs should use separate values for tempdir for that reason

[environment] Section

Sets shell environment variables when starting up.

PATH

If the server can’t find applications, append to the path. For example: PATH=/bin:/usr/bin:/usr/local/bin:/usr/local/pgsql/bin

PERL5LIB

On some operating systems like macOS the perl path may need to be set. For example, on macOS using Fink’s Perl libs it might be set like: PERL5LIB=/sw/lib/perl5

[paths] Section

templates

Templates base directory. Typically set to templates.

images

Images base directory. Typically set to UI/images.

localepath

Path to locale files. Defaults to locale/po.

templates_cache

Location where compiled templates are stored. When relative, appended to the directory specified by File::Spec->tmpdir().

Defaults to lsmb_templates.

workflows

Directory where workflow files are stored. Defaults to workflows

custom_workflows

Directory where custom workflow files are stored. Custom workflows are used to override behavior of the default workflows by providing actions, conditions, etc. with the same name and type or by providing workflows of the same type with additional states and actions. Defaults to custom_workflows.

[programs] Section

Setup the various helper programs that can be used with LedgerSMB.

[mail] Section

smtphost

The host name of the smtp server. If provided, then do not use local sendmail. Note that one of sendmail or smtphost has to be provided for email to work.

sendmail

Path the local sendmail executable. If provided then do not use an smtp server. Note that one of sendmail or smtphost has to be provided for email to work.

smtpport

The port number of the smtp server. Note this might vary depending on whether TLS or SSL is used.

smtpuser

The smpt server account name

smtpauthmech

The smtp server authentication method

smtppass

The smtp server password

backup_email_from

Set to enable e-mail delivery of backups. For example: backup_email_from = backups@lsmb_hosting.com

smtptimeout

The timeout value in seconds.

smtptls

If unset or ’no’ then do not use either TLS or SSL. If ’yes’ then use TLS and if ’tls’ use SSL for the smtp connection.

smtpsender_hostname

Override the default host name for helo.

[printers] Section

This section contains a list of printers and the commands to be executed in order for the output to be sent to the given printer with the document to be printed fed to the program through standard input.

The example below shows how to send standard input data to a printer called “laser” when selecting the item “Laser” in the LedgerSMB printer selection drop down.

Laser = lpr -Plaser

Or to an Epson Printer.

Epson = lpr -PEpson

[database] Section

host

Name of the host to connect to. See the documentation of the -h command line option at https://www.postgresql.org/docs/current/static/app-psql.html for more information (documentation unchanged since before 8.3, so applies to older versions as well)

port

Port number to be used to connect to. See the documentation of the -p option at the same URL as the previous item

default_db

Database to connect to when the “Company” entry field in the login screen is left blank

db_namespace

The name space the company resides in; expert setting – should not be used (default is “public”)

sslmode

Selects whether to use Secure Sockets Layer (SSL) over TCP connections or not; can be “require”, “allow”, “prefer” or “disable”. Default is “prefer”.