taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

libeufin-ebisync.1.rst (4533B)

      1 libeufin-ebisync(1)
      2 ###################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **libeufin-ebisync** - EBICS synchronization client.
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **libeufin-ebisync**
     16 [**-h** | **--help**]
     17 [**--version**]
     18 COMMAND [ARGS...]
     19 
     20 Subcommands: **dbinit**, **setup**, **fetch**, **serve**, **config**
     21 
     22 
     23 Description
     24 ===========
     25 
     26 **libeufin-ebisync** is a program that provides a service to synchronize ISO20022 files through the EBICS protocol
     27 
     28 Its options are as follows:
     29 
     30 **-h** \| **--help**
     31    Print short help on options.
     32 
     33 **–version**
     34    Print version information.
     35 
     36 The interaction model is as follows:
     37 
     38 - Configure the database with commands ``dbinit``.
     39 
     40 - Setup EBICS access with commands ``setup``. Setting the access means to share the client keys with the bank and downloading the bank keys
     41 
     42 - After a successful setup, the subcommand ``fetch`` can be run to respectively download files.
     43 
     44 The following sections describe each command in detail.
     45 
     46 dbinit
     47 ------
     48 
     49 This command defines the database schema for LibEuFin EbiSync. It is mandatory to run this command before invoking the ``setup`` command.
     50 
     51 Its options are as follows:
     52 
     53 **-c** \| **--config** *config_file*
     54    Specifies the configuration file.
     55 **-L** \| **--log** *LOGLEVEL*
     56    Configure logging to use LOGLEVEL.  
     57 **-r** \| **--reset**
     58    Reset database (DANGEROUS: All existing data is lost)
     59 **-h** \| **--help**
     60    Print short help on options.
     61 
     62 setup
     63 -----
     64 
     65 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.
     66 
     67 It is mandatory to run this command before invoking the ``fetch`` command.
     68 
     69 Its options are as follows:
     70 
     71 **-c** \| **--config** *config_file*
     72    Specifies the configuration file.
     73 **-L** \| **--log** *LOGLEVEL*
     74    Configure logging to use LOGLEVEL.  
     75 **--force-keys-resubmission**
     76   Resubmits all the keys to the bank.
     77 **--auto-accept-keys**
     78   Accepts the bank keys without interactively asking the user.
     79 **--generate-registration-pdf**
     80   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.
     81 **--debug-ebics** 
     82    Log EBICS transactions steps and payload at log_dir.
     83 **-h** \| **--help**
     84    Print short help on options.
     85 
     86 fetch
     87 -----
     88 
     89 This subcommand fetches ISO20022 files from the bank and store them at a configured destination.
     90 
     91 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.
     92 
     93 **-c** \| **--config** *config_file*
     94    Specifies the configuration file.
     95 **-L** \| **--log** *LOGLEVEL*
     96    Configure logging to use LOGLEVEL.
     97 **--transient**
     98    Execute once and return, ignoring the 'FREQUENCY' configuration value.
     99 **--pinned-start** *YYYY-MM-DD*
    100    Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents.
    101 **--peek**
    102    Only supported in --transient mode, do not consume fetched documents.
    103 **--checkpoint**
    104    Only supported in --transient mode, run a checkpoint.
    105 **--debug-ebics** *log_dir*
    106    Log EBICS transactions steps and payload at log_dir.
    107 **-h** \| **--help**
    108    Print short help on options.
    109 
    110 serve
    111 -----
    112 
    113 This command starts the HTTP server.
    114 
    115 Its options are as follows:
    116 
    117 **-c** \| **--config** *config_file*
    118    Specifies the configuration file.
    119 **-L** \| **--log** *LOGLEVEL*
    120    Configure logging to use LOGLEVEL. 
    121 **--check**
    122    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.
    123 **--debug-ebics** *log_dir*
    124    Log EBICS transactions steps and payload at log_dir.
    125 **-h** \| **--help**
    126    Print short help on options.
    127 
    128 .. include:: ../frags/common-config-cli.rst
    129 
    130 SEE ALSO
    131 ========
    132 
    133 libeufin-ebisync.conf(5)
    134 
    135 Bugs
    136 ====
    137 
    138 Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.