LIBEUFIN-EBISYNC(1)

NAME
libeufin-ebisync - service to synchronize files via EBICS

SYNOPSIS

libeufin-ebisync [-h | --help] [--version] COMMAND [ARGS...]

Subcommands: dbinit, setup, fetch, serve, config

DESCRIPTION

libeufin-ebisync is a program that provides a service to synchronize ISO20022 files through the EBICS protocol

Its options are as follows:

-h | --help
    Print short help on options.

–version
    Print version information.

    The interaction model is as follows:

•   Configure the database with commands dbinit.

•   Setup EBICS access with commands setup. Setting the access means to share the client keys with the bank and downloading the bank keys

•   After a successful setup, the subcommand fetch can be run to respectively download files.

    The following sections describe each command in detail.

  dbinit

This command defines the database schema for LibEuFin EbiSync. It is mandatory to run this command before invoking the setup command.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-r | --reset
    Reset database (DANGEROUS: All existing data is lost)

-h | --help
    Print short help on options.

  setup

This command creates the client keys, if they aren't found already on the disk, and sends them to the bank if they were not sent yet. In case of sending, it ejects the PDF document that contains the keys fingerprints, so that the user can send it to the bank to confirm their keys. The process continues by checking if the bank keys exist already on disk, and proceeds with downloading them in case they are not. It checks then if the bank keys were accepted by the user; if yes, the setup terminates, otherwise it interactively asks the user to mark the keys as accepted. By accepting the bank keys, the setup terminates successfully.

It is mandatory to run this command before invoking the fetch command.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

--force-keys-resubmission
    Resubmits all the keys to the bank.

--auto-accept-keys
    Accepts the bank keys without interactively asking the user.

--generate-registration-pdf
    Generates the PDF with the client keys fingerprints, if the keys have the submitted state. That's useful in case the PDF went lost after the first submission and the user needs a new PDF.

--debug-ebics
    Log EBICS transactions steps and payload at log_dir.

-h | --help
    Print short help on options.

  fetch

This subcommand fetches ISO20022 files from the bank and store them at a configured destination.

Fetches of new documents are executed at 'FREQUENCY' or any time a real-time EBICS notification is received. Every day, a checkpoint is performed, during which all documents since the last checkpoint are fetched.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

--transient
    Execute once and return, ignoring the 'FREQUENCY' configuration value.

--pinned-start YYYY-MM-DD
    Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents.

--peek
    Only supported in --transient mode, do not consume fetched documents.

--checkpoint
    Only supported in --transient mode, run a checkpoint.

--debug-ebics log_dir
    Log EBICS transactions steps and payload at log_dir.

-h | --help
    Print short help on options.

  serve

This command starts the HTTP server.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

--check
    Check whether an API is in use (if it's useful to start the HTTP server). Exit with 0 if at least one API is enabled, otherwise 1.

--debug-ebics log_dir
    Log EBICS transactions steps and payload at log_dir.

-h | --help
    Print short help on options.

  config

This command inspect or change the configuration.

-h | --help
    Print short help on options.

    Subcommands: get, dump, pathsub

  config get

This command lookup config value.

It takes two arguments, the section name and the option name

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-f | --filename
    Interpret value as path with dollar-expansion.

-h | --help
    Print short help on options.

  config dump

This command dump the configuration.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options.

  config pathsub

This command substitute variables in a path.

It takes one argument, a path expression.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options.

SEE ALSO

libeufin-ebisync.conf(5)

BUGS

Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.

AUTHOR
GNU Taler contributors

COPYRIGHT
2014-2025 Taler Systems SA (GPLv3+ or GFDL 1.3+)