epic-ts
[kivitendo-erp.git] / config / kivitendo.conf.default
index 127eb3c..07ae59d 100644 (file)
@@ -4,9 +4,16 @@
 # interface.
 admin_password = admin123
 
-# Which module to use for authentication. Valid values are 'DB' and
-# 'LDAP'.  If 'LDAP' is used then users cannot change their password
-# via kivitendo.
+# Which modules to use for authentication. Valid values are 'DB' and
+# 'LDAP'. You can use multiple modules separated by spaces.
+#
+# Multiple LDAP modules with different configurations can be used by
+# postfixing 'LDAP' with the name of the configuration section to use:
+# 'LDAP:ldap_fallback' would use the data from
+# '[authentication/ldap_fallback]'. The name defaults to 'ldap' if it
+# isn't given.
+#
+# Note that the LDAP module doesn't support changing the password.
 module = DB
 
 # The cookie name can be changed if desired.
@@ -43,6 +50,8 @@ password =
 # specified.
 #
 # tls:       Activate encryption via TLS
+# verify:    If 'tls' is used, how to verify the server's certificate.
+#            Can be one of 'require' or 'none'.
 # attribute: Name of the LDAP attribute containing the user's login name
 # base_dn:   Base DN the LDAP searches start from
 # filter:    An optional LDAP filter specification. The string '<%login%>'
@@ -51,6 +60,12 @@ password =
 #            If searching the LDAP tree requires user credentials
 #            (e.g. ActiveDirectory) then these two parameters specify
 #            the user name and password to use.
+# timeout:   Timeout when connecting to the server in seconds.
+#
+# You can specify a fallback LDAP server to use in case the main one
+# isn't reachable by duplicating this whole section as
+# "[authentication/ldap_fallback]".
+#
 host          = localhost
 port          = 389
 tls           = 0
@@ -59,42 +74,42 @@ base_dn       =
 filter        =
 bind_dn       =
 bind_password =
+timeout       = 10
+verify        = require
 
 [system]
-# Set language for login and admin forms. Currently "de" (German),
-# "de_DE" (new German) and "en" (English, not perfect) are available.
+# Set language for login and admin forms. Currently "de" (German)
+# and "en" (English, not perfect) are available.
 language = de
-
-# The database charset. Must match the encoding of the database cluster you want to
-# connect to. (Used on the shell command to create a database "pg_createcluster". Option "-e <encoding>".)
-dbcharset = UTF-8
-
-[features]
-# Activate certain optional features and modules.
-webdav = 0
-vertreter = 0
-
-# Show fields used for the best before date
-# ATTENTION! If you enabled this feature you can not simply turn it off again
-# without taking care that best_before fields are emptied in the database.
-# This can be done with the following query:
+# MassPrint Timeout
+# must be less than cgi timeout
 #
-#  UPDATE inventory SET bestbefore = NULL;
+massprint_timeout = 30
+
+# Set default_manager for admin forms. Currently "german"
+# and "swiss" are available.
+default_manager = german
+
+# The memory limits given here determine the maximum process size
+# (vsz, the total amount of memory this process uses including memory
+# swapped out or shared with other processes) or resident set size
+# (rss, the amount of memory not swapped out/shared with other
+# processes). If either limit is reached at the end of the request
+# then the kivitendo process will exit.
 #
-# Any stock contents containing a best before date will be impossible to stock
-# out otherwise.
-show_best_before = 0
-
-## Pictures for parts
-# Show the picture in the part form
-parts_show_image = 1
-# Style the picture with the following CSS code:
-parts_image_css = border:0;float:left;max-width:250px;margin-top:20px:margin-right:10px;margin-left:10px;
-# Show the picture in the results when you search for parts
-parts_listing_images = 0
-
-# Should payments be changeable after posting (0 = never; 1 = every time; 2 = on the same day)
-payments_changeable = 1
+# This only applies for processes under FCGI and the task manager.
+# For CGI configurations the process will be terminated after each request
+# regardless of this setting.
+#
+# Note: this will only terminate processes with too high memory consumption. It
+# is assumed that an external managing service will start new instances. For
+# FCGI this will usually be apache or the wrapper scripts for nginx, for the
+# task server this will have to be the system manager.
+#
+# Numbers can be postfixed with KB, MB, GB. If no number is given or
+# the number is 0 then no checking will be performed.
+memory_limit_rss =
+memory_limit_vsz =
 
 [paths]
 # path to temporary files (must be writeable by the web server)
@@ -105,23 +120,35 @@ spool = spool
 templates = templates
 # Path to the old memberfile (ignored on new installations)
 memberfile = users/members
+# Path to ELSTER geierlein webserver path inside kivitendo
+# (must be inside kivitendo but you can set an ALIAS for apache/oe
+# if set the export to geierlein is enabled
+# geierlein_path = geierlein
+
+#
+# document path for FileSystem FileManagement:
+#  (must be reachable read/write but not executable from webserver)
+# document_path = /var/local/kivi_documents
+#
 
 [mail_delivery]
-# Delivery method can be 'sendmail' or 'smtp' (the default). For
-# 'method = sendmail' the parameter 'mail_delivery.sendmail' is used
-# as the executable to call. If 'applications.sendmail' still exists
-# (backwards compatibility) then 'applications.sendmail' will be used
-# instead of 'mail_delivery.sendmail'.
+# Delivery method can be 'sendmail' or 'smtp'. For 'method = sendmail' the
+# parameter 'mail_delivery.sendmail' is used as the executable to call. If
+# 'applications.sendmail' still exists (backwards compatibility) then
+# 'applications.sendmail' will be used instead of 'mail_delivery.sendmail'.
+# If method is empty, mail delivery is disabled.
 method = smtp
 # Location of sendmail for 'method = sendmail'
 sendmail = /usr/sbin/sendmail -t<%if myconfig_email%> -f <%myconfig_email%><%end%>
-# Settings for 'method = smtp'.
+# Settings for 'method = smtp'. Only set 'port' if your SMTP server
+# runs on a non-standard port (25 for 'security=none' or
+# 'security=tls', 465 for 'security=ssl').
 host = localhost
-port = 25
+#port = 25
 # Security can be 'tls', 'ssl' or 'none'. Unset equals 'none'. This
 # determines whether or not encryption is used and which kind. For
-# 'tls' the module 'Net::SMTP::TLS' is required; for 'ssl'
-# 'Net::SMTP::TLS' is required and 'none' only uses 'Net::SMTP'.
+# 'tls' the module 'Net::SSLGlue' is required; for 'ssl'
+# 'Net::SMTP::SSL' is required and 'none' only uses 'Net::SMTP'.
 security = none
 # Authentication is only used if 'login' is set. You should only use
 # that with 'tls' or 'ssl' encryption.
@@ -139,13 +166,11 @@ html2ps = html2ps
 ghostscript = gs
 # Location of the pdflatex (or compatible, e.g. xetex) binary
 latex = pdflatex
-# Location of the two executables "pg_dump" and "pg_restore" used for
-# database backup and restoration from the admin section.  If
-# "pg_dump" or "pg_restore" is set to "DISABLED" then the
-# corresponding option (backup/restoration) will be hidden from the
-# admin section.
-pg_dump = pg_dump
-pg_restore = pg_restore
+# Location of the Python interpreter to use when converting from
+# OpenDocument to PDF. Some distributions compile UNO support only
+# into binaries located in different locations than the main Python
+# binary.
+python_uno = python
 
 [environment]
 # Add the following paths to the PATH environment variable.
@@ -153,6 +178,10 @@ path = /usr/local/bin:/usr/X11R6/bin:/usr/X11/bin
 # Add the following paths to the PERL5LIB environment variable.
 # "/sw/lib/perl5" is for Mac OS X with Fink's Perl.
 lib = /sw/lib/perl5
+# Add the following paths to the PYTHONPATH environment variable for
+# locating Python modules. Python is used when converting OpenDocument
+# files into PDF files.
+python_uno_path =
 
 [print_templates]
 # If you have LaTeX installed set to 1
@@ -169,23 +198,40 @@ openofficeorg_daemon = 1
 openofficeorg_daemon_port = 2002
 
 [task_server]
-# User name to use for database access
-login =
 # Set to 1 for debug messages in /tmp/kivitendo-debug.log
-debug = 1
+debug = 0
 # Chose a system user the daemon should run under when started as root.
 run_as =
+# Task servers can run on multiple machines. Each needs its own unique
+# ID. If unset, it defaults to the host name. All but one task server
+# must have 'only_run_tasks_for_this_node' set to 1.
+node_id =
+only_run_tasks_for_this_node = 0
+
+[task_server/notify_on_failure]
+# If you want email notifications for failed jobs then set this to a
+# kivitendo user (login) name. The subject can be changed as well.
+send_email_to  =
+# The "From:" header for said email.
+email_from     = kivitendo Daemon <root@localhost>
+# The subject for said email.
+email_subject  = kivitendo Task-Server: Hintergrundjob fehlgeschlagen
+# The template file used for the email's body.
+email_template = templates/webpages/task_server/failure_notification_email.txt
 
 [periodic_invoices]
-# The user name a report about the posted and printed invoices is sent
-# to.
-send_email_to  = mb
+# The user name or email address a report about the posted and printed
+# invoices is sent to.
+send_email_to  =
 # The "From:" header for said email.
 email_from     = kivitendo Daemon <root@localhost>
 # The subject for said email.
 email_subject  = Benachrichtigung: automatisch erstellte Rechnungen
 # The template file used for the email's body.
 email_template = templates/webpages/oe/periodic_invoices_email.txt
+# Whether to always send the mail (0), or only if there were errors
+# (1).
+send_for_errors_only = 0
 
 [self_test]
 
@@ -210,29 +256,11 @@ email_subject  = kivitendo self test report
 # template. currently txt and html templates are recognized and correctly mime send.
 email_template = templates/mail/self_test/status_mail.txt
 
-[datev_check]
-# it is possible to make a quick DATEV export everytime you post a record to ensure things
-# work nicely with their data requirements. This will result in a slight overhead though
-# you can enable this for each type of record independantly.
-
-# check when a sales invoice or a payment for a sales invoice is posted
-check_on_sales_invoice = 0
-# check when a purchase invoice or a payment for a purchase invoice is posted
-check_on_purchase_invoice = 0
-# check when an ar transaction is posted
-check_on_ar_transaction = 0
-# check when an ap transaction is posted
-check_on_ap_transaction = 0
-# check when a gl transaction is posted
-check_on_gl_transaction = 0
-
-# not implemented yet:
-#check_on_cash_and_receipt = 0
-#check_on_dunning = 0
-#check_on_sepa_import = 0
-
 [console]
-# autologin to use if none is given
+# Automatic login will only work if both "client" and "login" are
+# given.  "client" can be a client's database ID or its name. "login"
+# is simply a user's login name.
+client =
 login =
 
 # autorun lines will be executed after autologin.
@@ -251,8 +279,26 @@ log_file = /tmp/kivitendo_console_debug.log
 
 [testing]
 
-# autologin to use if none is given
-login = demo
+# Several tests need a database they can alter data in freely. This
+# database will be dropped & created before any other test is run. The
+# following parameters must be given:
+[testing/database]
+host               = localhost
+port               = 5432
+db                 =
+user               = postgres
+password           =
+template           = template1
+superuser_user     = postgres
+superuser_password =
+
+[devel]
+# Several settings related to the development of kivitendo.
+
+# "client" is used by several scripts (e.g. rose_auto_create_model.pl)
+# when they need access to the database. It can be either a client's
+# database ID or its name.
+client =
 
 [debug]
 # Use DBIx::Log4perl for logging DBI calls. The string LXDEBUGFILE
@@ -273,7 +319,7 @@ dbix_log4perl_config = log4perl.logger = FATAL, LOGFILE
                      = log4perl.appender.A1.layout.ConversionPattern=%d %p> %F{1}:%L %M - %m%n
 
 # Activate certain global debug messages. If you want to combine
-# several options then list them seperated by spaces.
+# several options then list them separated by spaces.
 #
 # Possible values include:
 #   NONE   - no debug output (default)
@@ -284,7 +330,11 @@ dbix_log4perl_config = log4perl.logger = FATAL, LOGFILE
 #   TRACE              - Track function calls and returns
 #   BACKTRACE_ON_ERROR - Print a function call backtrace when $form->error() is called
 #   REQUEST_TIMER      - Log timing of HTTP requests
+#   REQUEST            - Log each request. Careful! Passwords get filtered, but
+#                        there may be confidential information being logged here
 #   WARN               - warnings
+#   SHOW_CALLER        - include the file name & line number from where a call
+#                        to "message" or "dump" was called
 #   ALL                - all possible debug messages
 #
 #   DEVEL              - sames as "INFO QUERY TRACE BACKTRACE_ON_ERROR REQUEST_TIMER"
@@ -301,10 +351,6 @@ global_level = NONE
 # default.
 watch_form = 0
 
-# Include menu options for debugging in the HTML menu. Works only in
-# FastCGI mode.
-show_debug_menu = 0
-
 # If you want to debug the creation of LaTeX files then set this to 1.
 # That way the temporary LaTeX files created during PDF creation are
 # not removed and remain in the "users" directory.
@@ -317,3 +363,44 @@ restart_fcgi_process_on_changes = 0
 
 # The file name where the debug messages are written to.
 file_name = /tmp/kivitendo-debug.log
+
+# If set to 1 then the installation will be kept unlocked even if a
+# database upgrade fails.
+keep_installation_unlocked = 0
+
+# If set to 1 then all resource links (JavaScript, CSS files) output
+# via $::request->{layout}->use_stylesheet() / use_javascript() will
+# be made unique by appending a random GET parameter. This will cause
+# the web browser to always reload the resources.
+auto_reload_resources = 0
+
+# Alternative to auto_reload_resources. If the installation dir is under git
+# version control, this will use the HEAD commit sha1 as the random GET
+# parameter, so that resources are reloaded if the installed version charnges.
+git_commit_reload_recources = 0
+
+# If set to 1 each exception will include a full stack backtrace.
+backtrace_on_die = 0
+
+[cti]
+# If you want phone numbers to be clickable then this must be set to a
+# command that does the actually dialing. Within this command three
+# variables are replaced before it is executed:
+#
+# 1. <%phone_extension%> and <%phone_password%> are taken from the user
+#    configuration (changeable in the admin interface).
+# 2. <%number%> is the number to dial. It has already been sanitized
+#    and formatted correctly regarding e.g. the international dialing
+#    prefix.
+#
+# The following is an example that works with the OpenUC telephony
+# server:
+# dial_command = curl --insecure -X PUT https://<%phone_extension%>:<%phone_password%>@IP.AD.DR.ESS:8443/sipxconfig/rest/my/call/<%number%>
+dial_command =
+# If you need to dial something before the actual number then set
+# external_prefix to it.
+external_prefix = 0
+# The prefix for international calls (numbers starting with +).
+international_dialing_prefix = 00
+# Our own country code
+our_country_code = 49