taler-apns-relay(1)

19.30. taler-apns-relay(1)#

19.30.1. Name#

taler-apns-relay - Taler APNS relay.

19.30.2. Synopsis#

taler-apns-relay [-h | –help] [–version] COMMAND [ARGS…]

Subcommands: dbinit, setup, serve, worker, config

19.30.3. Description#

taler-apns-relay is a Taler APNs relay.

Its options are as follows:

-h | –help

Print short help on options.

–version

Print version information.

The interaction model is as follows:

  • Configure the database with commands dbinit.

  • Check API access with commands setup.

  • After a successful setup, the subcommands worker can be run to send background notifications to all registered device at a regular interval.

  • Start the HTTP server with command serve. Let this run in a shell, writing logs to stderr.

The following sections describe each command in detail.

19.30.3.1. dbinit#

This command defines the database schema for taler-apns-relay. It is mandatory to run this command before invoking the setup or serve commands.

Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-r | –reset

Reset database (DANGEROUS: All existing data is lost)

-h | –help

Print short help on options.

19.30.3.2. setup#

This command establishes a working API connection. It verifies that the current configuration.

Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-r | –reset

Reset connection info and overwrite keys file

-h | –help

Print short help on options.

19.30.3.3. worker#

This subcommand send background notifications to all registered device at a regular interval. Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

–transient

Execute once and return.

-h | –help

Print short help on options.

19.30.3.4. serve#

This command starts the HTTP server.

Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-h | –help

Print short help on options.

19.30.3.5. config#

This command inspect or change the configuration.

-h | –help

Print short help on options.

Subcommands: get, dump, pathsub

19.30.3.5.1. config get#

This command lookup config value.

It takes two arguments, the section name and the option name

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-f | –filename

Interpret value as path with dollar-expansion.

-h | –help

Print short help on options.

19.30.3.5.2. config dump#

This command dump the configuration.

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-h | –help

Print short help on options.

19.30.3.5.3. config pathsub#

This command substitute variables in a path.

It takes one argument, a path expression.

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-h | –help

Print short help on options.

19.30.4. SEE ALSO#

taler-apns-relay.conf(5)

19.30.5. Bugs#

Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.