commit 68da03e44733e10c5402b152fe242d7ec8cd97bc
parent 1536711db13af21366399bc621592e6e94a866eb
Author: Antoine A <>
Date: Wed, 1 Apr 2026 17:39:10 +0200
apns: add man pages
Diffstat:
3 files changed, 206 insertions(+), 0 deletions(-)
diff --git a/conf.py b/conf.py
@@ -1081,6 +1081,20 @@ man_pages = [
"GNU Taler contributors",
5,
),
+ (
+ "manpages/taler-apns-relay.1",
+ "taler-apns-relay",
+ "implementation of Taler APNs relay",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/taler-apns-relay.conf.5",
+ "taler-apns-relay.conf",
+ "APNs relay configuration file",
+ "GNU Taler contributors",
+ 5,
+ ),
]
# If true, show URL addresses after external links.
diff --git a/manpages/taler-apns-relay.1.rst b/manpages/taler-apns-relay.1.rst
@@ -0,0 +1,121 @@
+taler-apns-relay(1)
+###################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-apns-relay** - Taler APNS relay.
+
+
+Synopsis
+========
+
+**taler-apns-relay**
+[**-h** | **--help**]
+[**--version**]
+COMMAND [ARGS...]
+
+Subcommands: **dbinit**, **setup**,
+**serve**, **worker**, **config**
+
+
+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.
+
+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.
+
+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.
+
+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.
+
+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.
+
+.. include:: ../frags/common-config-cli.rst
+
+SEE ALSO
+========
+
+taler-apns-relay.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.
diff --git a/manpages/taler-apns-relay.conf.5.rst b/manpages/taler-apns-relay.conf.5.rst
@@ -0,0 +1,70 @@
+taler-apns-relay.conf(5)
+########################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-apns-relay.conf** - Taler APNs relay configuration file
+
+
+Description
+===========
+
+.. include:: ../frags/common-conf-syntax.rst
+
+Files containing default values for many of the options described below
+are installed under ``$TALER_APNS_RELAY_PREFIX/share/taler-apns-relay/config.d/``.
+The configuration file given with **-c** to Taler binaries
+overrides these defaults.
+
+A configuration file may include another, by using the ``@INLINE@`` directive,
+for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to
+include the entirety of ``sub.conf`` at that point in ``main.conf``.
+
+WORKER OPTIONS
+--------------
+
+The following options are from the “[apns-relay-worker]” section.
+
+KEY_FILE
+ Path to the Apple Push Notification private key
+
+KEY_ID
+ Key ID
+
+TEAM_ID
+ Team ID
+
+BUNDLE_ID
+ Bundle ID
+
+FREQUENCY
+ How often should worker wakeup all registered devices
+
+HTTP SERVER OPTIONS
+-------------------
+
+The following configuration value(s) belong to the “[apns-relay-httpd]” section.
+
+.. include:: frags/common-serve-options.rst
+
+DATABASE OPTIONS
+----------------
+
+Setting the database belongs to the “[apns-relaydb-postgres]” section and the following value.
+
+.. include:: frags/common-db-options.rst
+
+
+SEE ALSO
+========
+
+taler-apns-relay(1)
+
+BUGS
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
+\ No newline at end of file
