taler-docs

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

taler-magnet-bank.1.rst (4069B)

      1 taler-magnet-bank(1)
      2 ####################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **taler-magnet-bank** - Magnet Bank Taler adapter.
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **taler-magnet-bank**
     16 [**-h** | **--help**]
     17 [**--version**]
     18 COMMAND [ARGS...]
     19 
     20 Subcommands: **dbinit**, **setup**,
     21 **serve**, **worker**, **taler-deployment**, **config**
     22 
     23 
     24 Description
     25 ===========
     26 
     27 **taler-magnet-bank** is a Taler adapter for the Magnet Bank 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 - Setup API access with commands ``setup``. Setting the access means to generate an access token, to perform SCA check and upload some keys.
     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-magnet-bank. 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 setup a working API connection. This command create the keys file, if they aren't found already on the disk. It generate an access token, performs the SCA check and upload the public key.
     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 Magnet Bank API and sync the the bank account history.
     88 
     89 If ACCOUNT_TYPE is ``exchange``, incoming payments with an invalid Taler subject are bounced.
     90 
     91 Its options are as follows:
     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.
     99 **-h** \| **--help**
    100    Print short help on options.
    101 
    102 serve
    103 -----
    104 
    105 This command starts the HTTP server.
    106 
    107 Its options are as follows:
    108 
    109 **-c** \| **--config** *config_file*
    110    Specifies the configuration file.
    111 **-L** \| **--log** *LOGLEVEL*
    112    Configure logging to use LOGLEVEL. 
    113 **--check**
    114    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.
    115 **-h** \| **--help**
    116    Print short help on options.
    117 
    118 taler-deployment
    119 ----------------
    120 
    121 Helpers to integrate taler-magnet-bank with taler-exchange.
    122 
    123 **-h** \| **--help**
    124    Print short help on options.
    125 
    126 Subcommands: **exchange-payto**, **wire-gateway-credentials**
    127 
    128 taler-deployment exchange-payto 
    129 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    130 
    131 Output the exchange payto.
    132 
    133 **-c** \| **--config** *config_file*
    134    Specifies the configuration file.
    135 **-L** \| **--log** *LOGLEVEL*
    136    Configure logging to use LOGLEVEL.
    137 **-h** \| **--help**
    138    Print short help on options
    139 
    140 taler-deployment wire-gateway-credentials
    141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    142 
    143 Output the wire gateway credentials configuration.
    144 
    145 **-c** \| **--config** *config_file*
    146    Specifies the configuration file.
    147 **-L** \| **--log** *LOGLEVEL*
    148    Configure logging to use LOGLEVEL.
    149 **-h** \| **--help**
    150    Print short help on options
    151 
    152 .. include:: ../frags/common-config-cli.rst
    153 
    154 SEE ALSO
    155 ========
    156 
    157 taler-magnet-bank.conf(5)
    158 
    159 Bugs
    160 ====
    161 
    162 Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.