taler-docs

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

taler-wise.1.rst (2929B)

      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 subcommands ``worker`` can be run to both send payments and sync the bank account history.
     44 
     45 - Start the HTTP server with command ``serve``.
     46   Let this run in a shell, writing logs to stderr. 
     47 
     48 The following sections describe each command in detail.
     49 
     50 dbinit
     51 ------
     52 
     53 This command defines the database schema for taler-wise. It is mandatory to run this command before invoking the ``setup`` or ``serve`` commands.
     54 
     55 Its options are as follows:
     56 
     57 **-c** \| **--config** *config_file*
     58    Specifies the configuration file.
     59 **-L** \| **--log** *LOGLEVEL*
     60    Configure logging to use LOGLEVEL.  
     61 **-r** \| **--reset**
     62    Reset database (DANGEROUS: All existing data is lost)
     63 **-h** \| **--help**
     64    Print short help on options.
     65 
     66 setup
     67 -----
     68 
     69 This command establishes a working API connection. It verifies that the current configuration is valid and that the bank account has sufficient rights to function as an exchange.
     70 
     71 It is mandatory to run this command before invoking the ``worker`` command.
     72 
     73 Its options are as follows:
     74 
     75 **-c** \| **--config** *config_file*
     76    Specifies the configuration file.
     77 **-L** \| **--log** *LOGLEVEL*
     78    Configure logging to use LOGLEVEL.  
     79 **-r** \| **--reset**
     80    Reset connection info and overwrite keys file
     81 **-h** \| **--help**
     82    Print short help on options.
     83 
     84 worker
     85 ------
     86 
     87 This subcommand initiate transaction throught the Wise API and sync the balances account history.
     88 
     89 Its options are as follows:
     90 
     91 **-c** \| **--config** *config_file*
     92    Specifies the configuration file.
     93 **-L** \| **--log** *LOGLEVEL*
     94    Configure logging to use LOGLEVEL.
     95 **--transient**
     96    Execute once and return.
     97 **-h** \| **--help**
     98    Print short help on options.
     99 
    100 serve
    101 -----
    102 
    103 This command starts the HTTP server.
    104 
    105 Its options are as follows:
    106 
    107 **-c** \| **--config** *config_file*
    108    Specifies the configuration file.
    109 **-L** \| **--log** *LOGLEVEL*
    110    Configure logging to use LOGLEVEL. 
    111 **--check**
    112    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.
    113 **-h** \| **--help**
    114    Print short help on options.
    115 
    116 .. include:: ../frags/common-config-cli.rst
    117 
    118 SEE ALSO
    119 ========
    120 
    121 taler-wise.conf(5)
    122 
    123 Bugs
    124 ====
    125 
    126 Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.