commit 4d3bde413b86be30de56f71e7dd29ed109e988f4
parent 6febd4443fa84475cb2664ae571e629a0b275b21
Author: Christian Grothoff <christian@grothoff.org>
Date: Mon, 7 Apr 2025 16:14:39 +0200
bye-bye default, welcome admin instance
Diffstat:
2 files changed, 17 insertions(+), 16 deletions(-)
diff --git a/taler-merchant-api-tutorial.rst b/taler-merchant-api-tutorial.rst
@@ -151,7 +151,7 @@ A single Taler merchant backend server can be used by multiple
merchants that are separate business entities. Each of these separate
business entities is assigned a *merchant instance* which is identified by
an alphanumeric *instance id*. If the instance is omitted, the instance
-id ``default`` is assumed.
+id ``admin`` is assumed.
The following merchant instances are configured on
https://backend.demo.taler.net/:
@@ -162,7 +162,7 @@ https://backend.demo.taler.net/:
- ``Tor`` (The Tor Project), reachable at https://backend.demo.taler.net/instances/tor/
-- ``default`` (Kudos Inc.), reachable at https://backend.demo.taler.net/
+- ``admin`` (Kudos Inc.), reachable at https://backend.demo.taler.net/
- ``sandbox`` (for testing.), reachable at https://backend.demo.taler.net/instances/sandbox/
diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst
@@ -759,7 +759,7 @@ to perform all steps described in this section (and more!), using a simple Web
interface. Alternatively, you can also use the ``wget`` commands given below.
Regardless of which approach you use, the first step for using the backend
-involves the creation of a ``default`` instance. The ``default`` instance can
+involves the creation of the ``admin`` instance. The ``admin`` instance can
also create, configure or delete other instances, similar to the ``root``
account on UNIX. When no instance exists and ``taler-merchant-httpd`` was
started without the ``--auth`` option, then the backend is reachable without
@@ -783,7 +783,7 @@ Instance setup with the SPA
---------------------------
In order to setup an instance, you need the merchant backend to already be
-running, and you must either have the credentials for the "default" instance,
+running, and you must either have the credentials for the ``admin`` instance,
or no instance must be configured at all yet.
To start, point your browser to ``$PROTO://backend.$DOMAIN_NAME/``, replacing
@@ -816,7 +816,7 @@ interface create a file ``instance.json`` with an
.. code-block:: json
{
- "id" : "default",
+ "id" : "admin",
"name": "Example Inc.",
"address": { "country" : "zz" },
"auth": { "method" : "external"} ,
@@ -826,11 +826,11 @@ interface create a file ``instance.json`` with an
"default_pay_delay": { "d_ms" : 1209600000 }
}
-The ``name`` field will be shown as the name of your shop. The
-``address`` field is expected to contain your shop's physical address. The
-various defaults specify defaults for transaction fees your shop is willing to
-cover, how long offers made to the customer are valid, and how long the
-exchange has before it must wire the funds to your bank account. Those
+The ``name`` field will be shown as the name of your shop. The ``address``
+field is expected to contain your shop's physical address. The various
+``default_*`` values specify defaults for transaction fees your shop is
+willing to cover, how long offers made to the customer are valid, and how long
+the exchange has before it must wire the funds to your bank account. Those
defaults can be modified for individual orders. For details, see the
:ref:`contract terms <contract-terms>` specification.
@@ -840,9 +840,10 @@ You can then create the instance using:
$ wget --post-file=instance.json http://localhost:9966/management/instances
-The base URL for the instance will then be
-``http://localhost:9966/instances/default``. You can create additional
-instances by changing the ``id`` value to identifies other than ``default``.
+The base URL for the instance will then be ``http://localhost:9966/``. You
+can create additional instances, which will then be reachable under
+``http://localhost:9966/instances/$ID`` where ``$ID`` needs to be changed to
+the identifier value of the respective instance.
Endpoints to modify (reconfigure), permanently disable (while keeping the data)
or purge (deleting all associated data) instances exist as well and are documented
@@ -1060,7 +1061,7 @@ Access control
All endpoints with ``/private/`` in the URL must be restricted to authorized
users of the respective instance. Specifically, the HTTP server must be
configured to only allow access to ``$BASE_URL/private/`` to the authorized
-users of the default instance, and to ``$BASE_URL/instances/$ID/private/`` to
+users of the ``admin`` instance, and to ``$BASE_URL/instances/$ID/private/`` to
the authorized users of the instance ``$ID``.
By default, the GNU Taler merchant backend simply requires the respective
@@ -1341,9 +1342,9 @@ some of them being common to all subcommands:
The tool comes with two operation modes: *ordinary*, and *corner*.
The first just executes normal payments, meaning that it uses the
-default instance and make sure that all payments get aggregated. The
+``admin`` instance and make sure that all payments get aggregated. The
second gives the chance to leave some payments unaggregated, and also to
-use merchant instances other than the default (which is, actually, the
+use merchant instances other than ``admin`` (which is, actually, the
one used by default by the tool).
.. note::
