taler-docs

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

taler-wise.1.rst (3182B)


      1 taler-wise(1)
      2 ###############
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **taler-wise** - Wise Taler adapter.
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **taler-wise**
     16 [**-h** | **--help**]
     17 [**--version**]
     18 COMMAND [ARGS...]
     19 
     20 Subcommands: **dbinit**, **setup**,
     21 **serve**, **worker**, **config**
     22 
     23 
     24 Description
     25 ===========
     26 
     27 **taler-wise** is a Taler adapter for the Wise API.
     28 
     29 Its options are as follows:
     30 
     31 **-h** \| **--help**
     32    Print short help on options.
     33 
     34 **--version**
     35    Print version information.
     36 
     37 The interaction model is as follows:
     38 
     39 - Configure the database with commands ``dbinit``.
     40 
     41 - Check API access with commands ``setup``.
     42 
     43 - After a successful setup, the subcommand ``worker`` can be run to sync the balance histories.
     44   The adapter is read-only: it cannot send payments or bounce malformed transfers.
     45 
     46 - Start the HTTP server with command ``serve``.
     47   Let this run in a shell, writing logs to stderr. 
     48 
     49 The following sections describe each command in detail.
     50 
     51 dbinit
     52 ------
     53 
     54 This command defines the database schema for taler-wise. It is mandatory to run this command before invoking the ``setup`` or ``serve`` commands.
     55 
     56 Its options are as follows:
     57 
     58 **-c** \| **--config** *config_file*
     59    Specifies the configuration file.
     60 **-L** \| **--log** *LOGLEVEL*
     61    Configure logging to use LOGLEVEL.  
     62 **-r** \| **--reset**
     63    Reset database (DANGEROUS: All existing data is lost)
     64 **-h** \| **--help**
     65    Print short help on options.
     66 
     67 setup
     68 -----
     69 
     70 This command checks API access and the configured profile and balances, then
     71 initializes synchronization state from each balance's creation time. Existing
     72 synchronization state is preserved unless ``--reset`` is supplied.
     73 
     74 It is mandatory to run this command before invoking the ``worker`` command.
     75 
     76 Its options are as follows:
     77 
     78 **-c** \| **--config** *config_file*
     79    Specifies the configuration file.
     80 **-L** \| **--log** *LOGLEVEL*
     81    Configure logging to use LOGLEVEL.  
     82 **--reset**
     83    Reset all synchronization cursors and schedules to rescan from balance creation.
     84    Credentials and recorded transactions are preserved.
     85 **-h** \| **--help**
     86    Print short help on options.
     87 
     88 worker
     89 ------
     90 
     91 This subcommand synchronizes balance histories through the Wise API. It does not
     92 initiate transfers.
     93 
     94 Its options are as follows:
     95 
     96 **-c** \| **--config** *config_file*
     97    Specifies the configuration file.
     98 **-L** \| **--log** *LOGLEVEL*
     99    Configure logging to use LOGLEVEL.
    100 **--transient**
    101    Execute once and return.
    102 **-h** \| **--help**
    103    Print short help on options.
    104 
    105 serve
    106 -----
    107 
    108 This command starts the HTTP server.
    109 
    110 Its options are as follows:
    111 
    112 **-c** \| **--config** *config_file*
    113    Specifies the configuration file.
    114 **-L** \| **--log** *LOGLEVEL*
    115    Configure logging to use LOGLEVEL. 
    116 **--check**
    117    Validate the server configuration without starting the HTTP server. Exit with 0
    118    if it is valid, including when all optional APIs are disabled: the server also
    119    provides the Wise webhook endpoint.
    120 **-h** \| **--help**
    121    Print short help on options.
    122 
    123 .. include:: ../frags/common-config-cli.rst
    124 
    125 SEE ALSO
    126 ========
    127 
    128 taler-wise.conf(5)
    129 
    130 Bugs
    131 ====
    132 
    133 Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.