taler-docs

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

taler-apns-relay.1.rst (2664B)

      1 taler-apns-relay(1)
      2 ###################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **taler-apns-relay** - Taler APNS relay.
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **taler-apns-relay**
     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-apns-relay** is a Taler APNs relay.
     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 send background notifications to all registered device at a regular interval.
     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-apns-relay. 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.
     70 
     71 Its options are as follows:
     72 
     73 **-c** \| **--config** *config_file*
     74    Specifies the configuration file.
     75 **-L** \| **--log** *LOGLEVEL*
     76    Configure logging to use LOGLEVEL.  
     77 **-r** \| **--reset**
     78    Reset connection info and overwrite keys file
     79 **-h** \| **--help**
     80    Print short help on options.
     81 
     82 worker
     83 ------
     84 
     85 This subcommand send background notifications to all registered device at a regular interval.
     86 Its options are as follows:
     87 
     88 **-c** \| **--config** *config_file*
     89    Specifies the configuration file.
     90 **-L** \| **--log** *LOGLEVEL*
     91    Configure logging to use LOGLEVEL.
     92 **--transient**
     93    Execute once and return.
     94 **-h** \| **--help**
     95    Print short help on options.
     96 
     97 serve
     98 -----
     99 
    100 This command starts the HTTP server.
    101 
    102 Its options are as follows:
    103 
    104 **-c** \| **--config** *config_file*
    105    Specifies the configuration file.
    106 **-L** \| **--log** *LOGLEVEL*
    107    Configure logging to use LOGLEVEL.
    108 **-h** \| **--help**
    109    Print short help on options.
    110 
    111 .. include:: ../frags/common-config-cli.rst
    112 
    113 SEE ALSO
    114 ========
    115 
    116 taler-apns-relay.conf(5)
    117 
    118 Bugs
    119 ====
    120 
    121 Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.