taler-docs

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

commit 036687056efccf57ca9b42881ea955fbbee80a07
parent 00e64e338119476194ea87c26b50bc37aa9ce6ee
Author: Florian Dold <florian@dold.me>
Date:   Fri, 23 Aug 2024 11:25:43 +0200

remove mentions of taler-auditor-exchange, command has been removed

Diffstat:
Mconf.py | 7-------
Dmanpages/taler-auditor-exchange.1.rst | 77-----------------------------------------------------------------------------
Mmanpages/taler-auditor-offline.1.rst | 3+--
Mmanpages/taler-exchange-offline.1.rst | 10++++------
Mtaler-auditor-manual.rst | 27+++++----------------------
5 files changed, 10 insertions(+), 114 deletions(-)

diff --git a/conf.py b/conf.py @@ -379,13 +379,6 @@ man_pages = [ 5, ), ( - "manpages/taler-auditor-exchange.1", - "taler-auditor-exchange", - "add or remove exchange from auditor’s list", - "GNU Taler contributors", - 1, - ), - ( "manpages/taler-auditor-dbinit.1", "taler-auditor-dbinit", "setup auditor database", diff --git a/manpages/taler-auditor-exchange.1.rst b/manpages/taler-auditor-exchange.1.rst @@ -1,77 +0,0 @@ -taler-auditor-exchange(1) -########################## - -.. only:: html - - Name - ==== - - **taler-auditor-exchange** - add or remove exchange from auditor’s list - -Synopsis -======== - -**taler-auditor-exchange** -[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*] -[**-h** | **--help**] -[**-m** *MASTERKEY* | **--exchange-key=**\ ‌\ *MASTERKEY*] -[**-r** | **--remove**] -[**-u** *EXCHANGE_URL* | **--auditor-url=**\ ‌\ *EXCHANGE_URL*] -[**-v** | **--version**] - -Description -=========== - -**taler-auditor-exchange** is a command-line tool to be used by an -auditor to add or remove an exchange from the list of exchanges audited -by the auditor. You must add an exchange to that list before signing -denomination keys with taler-auditor-offline or trying to audit it with -taler-auditor or taler-wire-auditor. Afterwards the exchange will be -visible via the /exchanges API of the taler-auditor-httpd. - -**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME* - Use the configuration and other resources for the exchange to operate - from *FILENAME*. - -**-h** \| **--help** - Print short help on options. - -**-m** *MASTERKEY* \| **--exchange-key=**\ ‌\ *MASTERKEY* - Public key of the exchange in Crockford base32 encoding, for example - as generated by ``taler-auditor-offline setup``. - -**-r** \| **--remove** - Instead of adding the exchange, remove it. Note that this will drop - ALL data associated with that exchange, including existing auditing - information. So use with extreme care! - -**-u** *EXCHANGE_URL* \| **--auditor-url=**\ ‌\ *EXCHANGE_URL* - URL of the exchange. The exchange’s HTTP API must be available at - this address. - -**-v** \| **--version** - Print version information. - -Diagnostics -=========== - -**taler-auditor-exchange** will return 0 on success, 1 on usage errors, 3 on problems interacting with the database backend, 4 if exchange entry to be added is already in the database (or already missing when used with **-r**). - - -See Also -======== - -taler-auditor-offline(1), taler.conf(5) - -Bugs -==== - -We should optionally verify the correctness of this exchange’s base URL -and that it matches the master public key (note that the exchange may -still be offline, so it should be possible to bypass such a verification -step). Furthermore, if we do verification, as a (less secure) -convenience option, we should make **-** m optional and obtain it from -the base URL. - -Report bugs by using https://bugs.taler.net/ or by sending electronic -mail to <taler@gnu.org>. diff --git a/manpages/taler-auditor-offline.1.rst b/manpages/taler-auditor-offline.1.rst @@ -214,8 +214,7 @@ exchange operator when they used the **taler-exchange-offline** tool. See Also ======== -taler-auditor-exchange(1), taler-exchange-offline(1), -taler.conf(5) +taler-exchange-offline(1), taler.conf(5) Bugs ==== diff --git a/manpages/taler-exchange-offline.1.rst b/manpages/taler-exchange-offline.1.rst @@ -214,11 +214,9 @@ enable-auditor This subcommand informs an exchange that an auditor is to be activated. Afterwards, the exchange will accept inputs from that auditor's **taler-auditor-offline** -tool. Note that the auditor also must add the exchange to the list of -exchanges that it audits via **taler-auditor-exchange**. Furthermore, the -exchange's database will need to be provided to the auditor. This subcommand -only informs the exchange about the auditor, but does not perform those -additional mandatory steps for a working auditor. +tool. The exchange's database will need to be provided to the auditor. This +subcommand only informs the exchange about the auditor, but does not perform +those additional mandatory steps for a working auditor. The auditor's public key must be given in the usual base32-encoding as the first argument. @@ -635,7 +633,7 @@ change subsequently, the tool will refuse to sign. See Also ======== -taler-exchange-httpd(1), taler-auditor-offline(1), taler-auditor-exchange(1), taler.conf(5). +taler-exchange-httpd(1), taler-auditor-offline(1), taler.conf(5). Bugs ==== diff --git a/taler-auditor-manual.rst b/taler-auditor-manual.rst @@ -493,22 +493,7 @@ FIXME-DOLD: explain how that Web page works, once it works... Exchange -------- -The next step is to add the exchange's master public key and the base URL of -the exchange to the list of exchanges audited by the auditor. This is done -using the ``taler-auditor-exchange`` tool. The tool basically creates the -respective record in the auditor's database. - -If this step is skipped, the auditor will malfunction at all future stages -with a foreign key violation, as it does not know the exchange's master public -key. - -.. code-block:: console - - # As the 'auditor' user: - $ taler-auditor-exchange -m $MASTER_PUB -u $EXCHANGE_BASE_URL - -An equivalent step must be performed by the exchange operator. Here, the -exchange operator must use the ``taler-exchange-offline`` tool to add the +The exchange operator must use the ``taler-exchange-offline`` tool to add the auditor's public key, base URL and (business) name to the list of approved auditors of the exchange. For details, see :ref:`Auditor-configuration` in the exchange operator manual. @@ -896,12 +881,10 @@ The auditor database can be reset using: $ taler-auditor-dbinit -R However, running this command will result in all data in the database being -*lost*, including steps like enabling an exchange using -``taler-auditor-exchange``. Thus, doing so may result in significant -commputation (and bandwidth consumption with the bank) when the auditor is -next launched, as it will re-download and re-verify all historic transactions. -Hence this should not be done in a production system. - +*lost*. Thus, doing so may result in significant commputation (and bandwidth +consumption with the bank) when the auditor is next launched, as it will +re-download and re-verify all historic transactions. Hence this should not be +done in a production system. .. _AuditorRevocations: