config.example.ini

; Hi there! This is the configuration file for
; Kresus. Please make sure to read all the options before setting up
; Kresus for the first time.
;
[kresus]

; This is where Kresus stores additional data, as the latest bank
; scrapping modules. It should be writable by the user which launches
; the Kresus executable.
; Can be removed; defaults to HOME_DIR/.kresus.
; Overridden by the KRESUS_DIR environment variable, if it's set.
; Example:
; datadir=/home/ben/.kresus
datadir=

; A user id obtained from using the "kresus create-user" command.
; This allows sharing a single database with several users. If your
; instance is only planned to host a single user, you can keep it
; disabled, and Kresus will know how to automatically generate a new
; user.
; Overridden by the KRESUS_USER_ID environment variable, if it's set.
; Example:
; userid=1
userid=

; A HTTP header name to check when trying to retrieve the login of a pre-authenticated
; user. The HTTP header should then provide a valid login (one previously created from the
; "kresus create-user" command).
; Overridden by the KRESUS_USER_LOGIN_HTTP_HEADER environment variable, if it's set.
; Example:
; userLoginHttpHeader=YNH_USER
userLoginHttpHeader=

; This is the port that Kresus will run on. It is recommended not
; to expose it on port 80 directly but to use a reverse-proxy
; configuration like Nginx, Caddy or Apache.
; Can be removed; defaults to 9876.
; Overridden by the PORT environment variable, if it's set.
; Example:
; port=9876
port=

; The host on which the Kresus server will listen to.
; Can be removed; defaults to 127.0.0.1.
; Overridden by the HOST environment variable, if it's set.
; Example:
; host=127.0.0.1
host=

; The executable version of Python that is going to get used when
; interacting with Python scripts. This can be python or python3.
; Can be removed; defaults to python3.
; Overridden by the KRESUS_PYTHON_EXEC environment variable, if it's set.
; Example:
; python_exec=python3
python_exec=

; The directory prefix in the URL, if Kresus is to be served from a
; subdirectory. For instance, if your website is hosted at example.com
; and the url prefix is "money", then Kresus will be reachable at
; example.com/money. By default, it's '', meaning that Kresus has its own
; subdomain.
; Can be removed; defaults to "".
; Overridden by the KRESUS_URL_PREFIX environment variable, if it's set.
; Example:
; url_prefix=/money
url_prefix=

; A salt value used in encryption algorithms (used for instance to
; encrypt/decrypt exports). It should be a random string value with
; at least 16 characters if you decide to provide it.
; Overridden by the KRESUS_SALT environment variable, if it's set.
; Example:
; salt=gj4J89fkjf4h29aDi0f{}fu4389sejk`9osk`
salt=

; Set this to true if you want to use this instance only in demo
; mode, and to never allow users to link their personal accounts.
;
; WARNING! Switching this on and off may trigger data loss. Note that it
; is still possible to try Kresus in demo mode, even if this is not set
; to true. Setting this to true will *force* demo mode, and prevent users
; from leaving this mode.
; Can be removed; defaults to false.
; Overridden by the KRESUS_FORCE_DEMO_MODE environment variable, if it's set.
; Example:
; force_demo_mode=true
force_demo_mode=

; If set to a string, will enable HTTP Basic Auth, by splitting the
; string on a colon, i.e. "<username>:<passwd>"
; Overridden by the KRESUS_AUTH environment variable, if it's set.
; Example:
; auth=foo:bar
auth=

[woob]

; The directory in which Woob core is stored. If empty, indicates
; that woob is already in the PYTHON_PATH (e.g. installed at the global
; level)
; Overridden by the KRESUS_WOOB_DIR environment variable, if it's set.
; Example:
; srcdir=/home/ben/code/woob
srcdir=

; Path to a file containing a valid Woob's source list directory.
; If empty (the default), indicates that Kresus will generate its own
; source list file and will store it in
; KRESUS_DIR/woob-data/sources.list.
; Overridden by the KRESUS_WOOB_SOURCES_LIST environment variable, if it's set.
; Example:
; sources_list=/home/ben/code/woob/sources.list
sources_list=

[email]

; The transport method you want to use. Can be either:
; * "sendmail": relies on sendmail executable to be available on your
; system and only sendmail-specific parameters are used,
;
; * "smtp": you should provide proper SMTP credentials to use, in the
; dedicated configuration entries.
;
; If empty, no emails will be sent by Kresus.
; Overridden by the KRESUS_EMAIL_TRANSPORT environment variable, if it's set.
; Example:
; transport=smtp
transport=

; The path to the sendmail executable to use. If empty, indicates
; that the default sendmail executable will be used.
; Overridden by the KRESUS_EMAIL_SENDMAIL_BIN environment variable, if it's set.
; Example:
; sendmail_bin=/usr/bin/sendmail
sendmail_bin=

; The email address from which email alerts will be sent. Make sure
; that your domain DNS is correctly configured and that you've done
; what's needed to prevent email alerts from landing in the spam folder.
; Overridden by the KRESUS_EMAIL_FROM environment variable, if it's set.
; Example:
; from=kresus@domain.tld
from=

; The network address (ipv4, ipv6 or FQDN) of the SMTP server.
; Overridden by the KRESUS_EMAIL_HOST environment variable, if it's set.
; Example:
; host=mail.domain.tld
host=

; The port to which the SMTP server listens. Default values tend to
; be: 25 (server to server), or 587 (clients to server), or 465
; (nonstandard).
; Overridden by the KRESUS_EMAIL_PORT environment variable, if it's set.
; Example:
; port=465
port=

; The username used during authentication to the SMTP server. If
; empty, indicates an anonymous connection will be used.
; Overridden by the KRESUS_EMAIL_USER environment variable, if it's set.
; Example:
; user=login
user=

; The password used during authentication to the SMTP server. If
; empty, indicates no password will be used.
; Overridden by the KRESUS_EMAIL_PASSWORD environment variable, if it's set.
; Example:
; password=hunter2
password=

; If set to true, will force using a TLS connection. By default,
; emails are sent with STARTTLS, i.e. using TLS if available.
; Can be removed; defaults to false.
; Overridden by the KRESUS_EMAIL_FORCE_TLS environment variable, if it's set.
; Example:
; force_tls=false
force_tls=

; If set to false, will allow self-signed TLS certificates.
; Can be removed; defaults to true.
; Overridden by the KRESUS_EMAIL_REJECT_UNAUTHORIZED_TLS environment variable, if it's set.
; Example:
; reject_unauthorized_tls=true
reject_unauthorized_tls=

[notifications]

; The baseurl from which apprise-api will be called for
; notifications to be sent.
; See https://github.com/caronc/apprise-api#installation for
; installation
; Overridden by the KRESUS_APPRISE_API_BASE_URL environment variable, if it's set.
; Example:
; appriseApiBaseUrl=http://localhost:8000/
appriseApiBaseUrl=

[logs]

; The path to the log file to use. If empty, defaults to kresus.log
; in datadir.
; Overridden by the KRESUS_LOG_FILE environment variable, if it's set.
; Example:
; log_file=/var/log/kresus.log
log_file=

[db]

; Database type supported by Kresus, to choose among:
; - postgres
; - sqlite
;
; It must be set by the user. PostgreSQL is recommended and strongly supported; your experience with other databases might vary.
;
; Note using sqlite is *strongly discouraged* because it can't properly handle certain kinds of database migrations. It is only intended for development purposes.
; Overridden by the KRESUS_DB_TYPE environment variable, if it's set.
; Example:
; type=sqlite
type=

; Logging level for the SQL queries. Possible values are:
;
; - all: will log every SQL query, including queries causing errors.
; - error (default value): will only log SQL queries resulting in errors. This is useful for debugging purposes.
; - none: nothing will be logged.
; Can be removed; defaults to error.
; Overridden by the KRESUS_DB_LOG environment variable, if it's set.
; Example:
; log=error
log=

; Path to the sqlite database file. Make sure that the user running
; Kresus has the right permissions to write into this file. Required only for
; sqlite.
; Overridden by the KRESUS_DB_SQLITE_PATH environment variable, if it's set.
; Example:
; sqlite_path=/tmp/dev.sqlite
sqlite_path=

; Path to a directory containing a Unix socket to connect to the
; database, or host address of the database server. Required for postgres.
;
; If using a Unix socket, the socket file's name will be inferred from the
; standard postgres name and the port number.
; Can be removed; defaults to localhost for postgres.
; Overridden by the KRESUS_DB_HOST environment variable, if it's set.
; Example:
; host=localhost
host=

; Port of the database server. Required for postgres, even when
; using a Unix socket (the port is used to compute the socket's file name).
; Can be removed; defaults to 5432 for postgres.
; Overridden by the KRESUS_DB_PORT environment variable, if it's set.
; Example:
; port=5432
port=

; Username to connect to the database server. Required for postgres.
; Overridden by the KRESUS_DB_USERNAME environment variable, if it's set.
; Example:
; username=benjamin
username=

; Password to connect to the database server. Required for postgres.
; Overridden by the KRESUS_DB_PASSWORD environment variable, if it's set.
; Example:
; password=hunter2
password=

; Database name to use. Required for postgres.
; Can be removed; defaults to kresus.
; Overridden by the KRESUS_DB_NAME environment variable, if it's set.
; Example:
; name=kresus
name=