gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated (be6e36f -> 65f1f98)


From: gnunet
Subject: [taler-docs] branch master updated (be6e36f -> 65f1f98)
Date: Mon, 08 Feb 2021 10:07:03 +0100

This is an automated email from the git hooks/post-receive script.

ttn pushed a change to branch master
in repository docs.

    from be6e36f  change markup from " to ``
     new 773cf35  mark up ‘payto://’; change markup from " to `` (two instances)
     new eb3949a  add markup (four instances)
     new e91a4bc  add markup
     new 9bf6456  add markup (six instances)
     new ef9126d  add markup (four instances)
     new 7d57b71  add markup (five instances)
     new f3b6f31  add markup (five instances)
     new 918cc95  add markup
     new 2217073  add markup (two instances)
     new 9e7cd4a  add colon (three instances)
     new a388a95  fix typo: s/provide/provides/
     new c85a992  fix typo: s/setup/set up/
     new 242e78e  add markup
     new 8380e61  add hyphen
     new 65f1f98  s/as/for example/

The 15 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 taler-merchant-manual.rst | 68 +++++++++++++++++++++++------------------------
 1 file changed, 34 insertions(+), 34 deletions(-)

diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst
index f8e6e64..e27c656 100644
--- a/taler-merchant-manual.rst
+++ b/taler-merchant-manual.rst
@@ -814,8 +814,8 @@ See RFC 8905 for the format of ``payto://``-URIs.
 
 For first tests, you should sign up for a KUDOS bank
 account at `https://bank.demo.taler.net/ <https://bank.demo.taler.net/>`_.
-In this case, the payto://-URI will be of the form
-"payto://x-taler-bank/bank.demo.taler.net/$USERNAME" where "$USERNAME"
+In this case, the ``payto://``-URI will be of the form
+``payto://x-taler-bank/bank.demo.taler.net/$USERNAME`` where ``$USERNAME``
 must be replaced with the name of the account that was established
 at `https://bank.demo.taler.net/ <https://bank.demo.taler.net/>`_.
 
@@ -825,16 +825,16 @@ IBAN Accounts
 
 When deploying Taler with the real banking system, you primarily need to
 change the currency of the configuration from KUDOS to the actual currency
-(such as EUR, USD, CHF) and provide a payto://-URI of your real bank
+(such as EUR, USD, CHF) and provide a ``payto://``-URI of your real bank
 account. In Europe, this will involve knowing your IBAN number. If you have an
-IBAN, the corresponding payto://-URI is simply "payto://iban/$IBAN" where
-"$IBAN" must be replaced with the actual IBAN number.
+IBAN, the corresponding ``payto://``-URI is simply ``payto://iban/$IBAN`` where
+``$IBAN`` must be replaced with the actual IBAN number.
 
 
 Setup
 ------
 
-With the knowledge of the payto://-URI, instances can be configured by POSTing
+With the knowledge of the ``payto://``-URI, instances can be configured by 
POSTing
 a request to :http:post:`/private/instances`.  To create a first instance,
 create a file ``instance.json`` with an `InstanceConfigurationMessage`
 
@@ -853,10 +853,10 @@ create a file ``instance.json`` with an 
`InstanceConfigurationMessage`
      "default_pay_delay": { "d_ms" : 1209600000 }
    }
 
-In the text above, you must replace "$PAYTO_URI" with your actual
-payto://-URI. Also, be sure to replace KUDOS with the fiat currency if the
-setup is for an actual bank. The "name" field will be shown as the name of
-your shop. The "address" field is expected to contain your shop's physical
+In the text above, you must replace ``$PAYTO_URI`` with your actual
+``payto://``-URI. Also, be sure to replace KUDOS with the fiat currency if the
+setup is for an actual bank. 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
@@ -871,7 +871,7 @@ You can then create the instance using:
 
 The base URL for the instance will then be
 ``http://localhost:8888/instances/default``.  You can create additional
-instances by changing the "id" value to identifies other than "default".
+instances by changing the ``id`` value to identifies other than ``default``.
 
 Endpoints to modify (reconfigure), permanently disable (while keeping the data)
 or purge (deleting all associated data) instances exist as well and are 
documented
@@ -937,8 +937,8 @@ process after changing the ``SERVE`` configuration.
 Apache
 ^^^^^^
 
-In Apache, make sure you have "mod_proxy", "mod_proxy_http" and
-"mod_headers" enabled:
+In Apache, make sure you have ``mod_proxy``, ``mod_proxy_http`` and
+``mod_headers`` enabled:
 
 .. code-block:: console
 
@@ -957,7 +957,7 @@ endpoint):
        </Location>
 
 Note that the above again assumes your domain name is ``example.com`` and that
-you have TLS configured.  Note that you must add the "https" header unless
+you have TLS configured.  Note that you must add the ``https`` header unless
 your site is not available via TLS.
 
 The above configuration(s) are both incomplete. You must still additionally
@@ -996,10 +996,10 @@ follows:
           proxy_pass ...; // as above
       }
 
-Here, "SECURITYTOKEN" should be replaced with the actual shared secret.  Note
-that the "~" ensures that the above matches all endpoints that include the
-string "/private/".  If you only run a single instance, you could simply
-specify "/private/" without the "~" to only configure the access policy for
+Here, ``SECURITYTOKEN`` should be replaced with the actual shared secret.  Note
+that the ``~`` ensures that the above matches all endpoints that include the
+string ``/private/``.  If you only run a single instance, you could simply
+specify ``/private/`` without the ``~`` to only configure the access policy for
 the default instance.
 
 If you are running different instances on the same backend, you
@@ -1033,7 +1033,7 @@ each instance:
 Apache
 ^^^^^^
 
-For Apache, you should first enable "mod_rewrite":
+For Apache, you should first enable ``mod_rewrite``:
 
 .. code-block:: console
 
@@ -1051,10 +1051,10 @@ Then, you can restrict to an access control token using:
        ProxyPass "unix:/some/path/here.sock|http://example.com/";
        </Location>
 
-Here, "SECURITYTOKEN" should be replaced with the actual shared secret.  Note
-that the "(.+)" ensures that the above matches all endpoints that include the
-string "/private/".  If you only run a single instance, you could simply
-specify "/private/" without the "~" to only configure the access policy for
+Here, ``SECURITYTOKEN`` should be replaced with the actual shared secret.  Note
+that the ``(.+)`` ensures that the above matches all endpoints that include the
+string ``/private/``.  If you only run a single instance, you could simply
+specify ``/private/`` without the ``~`` to only configure the access policy for
 the default instance.
 
 If you are running different instances on the same backend, you
@@ -1138,7 +1138,7 @@ Limitations
 
 All of the static files must fit into memory and it must be possible for the
 process to hold open file handles for all of these files.  You may want
-to increase the "ulimit" of the ``taler-merchant-httpd`` process if you have
+to increase the ``ulimit`` of the ``taler-merchant-httpd`` process if you have
 templates for many languages.
 
 The backend determines the MIME type based on the file's extension. The list
@@ -1206,7 +1206,7 @@ Fund the reserve
 
 First, the reserve must be setup in the merchant backend. A reserve
 is always tied to a particular instance. To create a reserve with
-10 KUDOS at instance "default" using the demo exchange, use:
+10 KUDOS at instance ``default`` using the demo exchange, use:
 
 .. code-block:: console
 
@@ -1220,7 +1220,7 @@ port 8888. The current implementation of the tool does 
not yet support
 transmission of authentication information to the backend
 (`see bug 6418 <https://bugs.gnunet.org/view.php?id=6418>`_).
 
-The command will output a payto:// URI which specifies where to
+The command will output a ``payto://`` URI which specifies where to
 wire the funds and which wire transfer subject to use.
 
 FIXME: add full example output.
@@ -1396,7 +1396,7 @@ The tool ``taler-config`` can be used to extract or 
manipulate
 configuration values; however, the configuration use the well-known INI
 file format and can also be edited by hand.
 
-Run
+Run:
 
 .. code-block:: console
 
@@ -1404,7 +1404,7 @@ Run
 
 to list all of the configuration values in section ``$SECTION``.
 
-Run
+Run:
 
 .. code-block:: console
 
@@ -1413,7 +1413,7 @@ Run
 to extract the respective configuration value for option ``$option`` in
 section ``$section``.
 
-Finally, to change a setting, run
+Finally, to change a setting, run:
 
 .. code-block:: console
 
@@ -1455,7 +1455,7 @@ Benchmarking
 
 The merchant codebase offers the ``taler-merchant-benchmark`` tool to
 populate the database with fake payments. This tool is in charge of
-starting a merchant, exchange, and bank processes, and provide them all
+starting a merchant, exchange, and bank processes, and provides them all
 the input to accomplish payments. Note that each component will use its
 own configuration (as they would do in production).
 
@@ -1496,7 +1496,7 @@ Note that the public key must match the exchange's
 private key and that the Postgres database must
 exist before launching the benchmark.  You also
 will need to ensure that the Exchange's
-details are setup.
+details are set up.
 For details, see the :ref:`Exchange Operator Manual <Bank-account>`.
 
 
@@ -1510,7 +1510,7 @@ one of them being mandatory:
    section specifies the bank account for the exchange that
    should be used for the benchmark. For the example
    configuration above, the SECTION value provided must be
-   "exchange-account-exchange".
+   ``exchange-account-exchange``.
 
 The tool comes with two operation modes: *ordinary*, and *corner*.
 The first just executes normal payments, meaning that it uses the
@@ -1520,7 +1520,7 @@ use merchant instances other than the default (which is, 
actually, the
 one used by default by the tool).
 
 Note: the ability of driving the aggregation policy is useful for testing
-the backoffice facility.
+the back-office facility.
 
 Any subcommand is also equipped with the canonical ``--help`` option, so
 feel free to issue the following command in order to explore all the
@@ -1610,7 +1610,7 @@ this stage of development, you should also ignore some 
(harmless) error
 message from postresql about already existing roles and databases.
 
 To test if everything worked as expected, it suffices to issue a simple
-request to the merchant, as:
+request to the merchant, for example:
 
 .. code-block:: console
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]