summaryrefslogtreecommitdiff
path: root/texinfo/taler-merchant.texi
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-01-27 10:23:00 +0100
committerChristian Grothoff <christian@grothoff.org>2021-01-27 10:23:00 +0100
commit488608716fcd0fa90013f7136cb4bee4822f972d (patch)
tree949bc810cb9888ce9856b7a15e93867ba0ae5a2d /texinfo/taler-merchant.texi
parent4739f1447d0e8a6534c7fbdbc361d5d756d1875b (diff)
downloaddocs-488608716fcd0fa90013f7136cb4bee4822f972d.tar.gz
docs-488608716fcd0fa90013f7136cb4bee4822f972d.tar.bz2
docs-488608716fcd0fa90013f7136cb4bee4822f972d.zip
update docs
Diffstat (limited to 'texinfo/taler-merchant.texi')
-rw-r--r--texinfo/taler-merchant.texi167
1 files changed, 110 insertions, 57 deletions
diff --git a/texinfo/taler-merchant.texi b/texinfo/taler-merchant.texi
index 90554002..af3159e5 100644
--- a/texinfo/taler-merchant.texi
+++ b/texinfo/taler-merchant.texi
@@ -21,7 +21,7 @@
@copying
@quotation
-GNU Taler 0.8.0pre0, Jan 21, 2021
+GNU Taler 0.8.0pre0, Jan 27, 2021
GNU Taler team
@@ -86,6 +86,7 @@ Installation
* Generic instructions for installation from source::
* Installing the GNU Taler binary packages on Debian::
+* Installing the GNU Taler binary packages on Ubuntu::
* Installing Taler on Debian GNU/Linux from source::
Generic instructions for installation from source
@@ -499,6 +500,7 @@ This chapter describes how to install the GNU Taler merchant backend.
@menu
* Generic instructions for installation from source::
* Installing the GNU Taler binary packages on Debian::
+* Installing the GNU Taler binary packages on Ubuntu::
* Installing Taler on Debian GNU/Linux from source::
@end menu
@@ -697,7 +699,7 @@ run @code{ldconfig}. Without this step, it is possible that the linker may not
find the installed libraries and launching the Taler merchant backend would
then fail.
-@node Installing the GNU Taler binary packages on Debian,Installing Taler on Debian GNU/Linux from source,Generic instructions for installation from source,Installation
+@node Installing the GNU Taler binary packages on Debian,Installing the GNU Taler binary packages on Ubuntu,Generic instructions for installation from source,Installation
@anchor{taler-merchant-manual installing-the-gnu-taler-binary-packages-on-debian}@anchor{1d}
@section Installing the GNU Taler binary packages on Debian
@@ -744,7 +746,7 @@ Next, you must import the Taler Systems SA public package signing key
into your keyring and update the package lists:
@example
-# wget -O - https://taler.net/taler-systems.gpg.key | apt-sign add -
+# wget -O - https://taler.net/static/taler-systems.gpg.key | apt-key add -
# apt update
@end example
@@ -770,8 +772,66 @@ fragment for Nginx or Apache will be placed in
furthermore still configure the instances, and may need to extend the fragment
with access control restrictions for non-default instances.
-@node Installing Taler on Debian GNU/Linux from source,,Installing the GNU Taler binary packages on Debian,Installation
-@anchor{taler-merchant-manual installing-taler-on-debian-gnu-002flinux}@anchor{1e}@anchor{taler-merchant-manual installing-taler-on-debian-gnu-linux-from-source}@anchor{1f}
+@node Installing the GNU Taler binary packages on Ubuntu,Installing Taler on Debian GNU/Linux from source,Installing the GNU Taler binary packages on Debian,Installation
+@anchor{taler-merchant-manual installing-the-gnu-taler-binary-packages-on-ubuntu}@anchor{1e}
+@section Installing the GNU Taler binary packages on Ubuntu
+
+
+To install the GNU Taler Ubuntu packages, first ensure that you have
+the right Ubuntu distribution. At this time, the packages are built for
+Ubuntu 20.04 LTS (Focal Fossa).
+
+A typical @code{/etc/apt/sources.list} file for this setup
+would look like this:
+
+@example
+deb http://ch.archive.ubuntu.com/ubuntu/ focal main restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal-updates main restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal-security main restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal universe restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal-updates universe restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal-security universe restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal multiverse restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal-updates multiverse restricted
+deb http://ch.archive.ubuntu.com/ubuntu/ focal-security multiverse restricted
+
+deb https://deb.taler.net/apt/ubuntu/ focal-fossa main
+@end example
+
+The last line is crucial, as it adds the GNU Taler packages.
+
+Next, you must import the Taler Systems SA public package signing key
+into your keyring and update the package lists:
+
+@example
+# wget -O - https://taler.net/static/taler-systems.gpg.key | apt-sign add -
+# apt update
+@end example
+
+@cartouche
+@quotation Note
+You may want to verify the correctness of the Taler Systems key out-of-band.
+@end quotation
+@end cartouche
+
+Now your system is ready to install the official GNU Taler binary packages
+using apt.
+
+To install the Taler merchant backend, you can now simply run:
+
+@example
+# apt install taler-merchant
+@end example
+
+Note that the package does not complete the integration of the backend with
+the HTTP reverse proxy (typically with TLS certificates). A configuration
+fragment for Nginx or Apache will be placed in
+@code{/etc/@{apache,nginx@}/conf-available/taler-merchant.conf}. You must
+furthermore still configure the instances, and may need to extend the fragment
+with access control restrictions for non-default instances.
+
+@node Installing Taler on Debian GNU/Linux from source,,Installing the GNU Taler binary packages on Ubuntu,Installation
+@anchor{taler-merchant-manual installing-taler-on-debian-gnu-002flinux}@anchor{1f}@anchor{taler-merchant-manual installing-taler-on-debian-gnu-linux-from-source}@anchor{20}
@section Installing Taler on Debian GNU/Linux from source
@@ -839,7 +899,7 @@ if you used the Debian stretch instructions above, you need to pass
@code{--with-microhttpd=/usr/local/} to all @code{configure} invocations.
@node How to configure the merchant’s backend,Instance setup,Installation,Top
-@anchor{taler-merchant-manual how-to-configure-the-merchants-backend}@anchor{20}
+@anchor{taler-merchant-manual how-to-configure-the-merchants-backend}@anchor{21}
@chapter How to configure the merchant’s backend
@@ -866,7 +926,7 @@ commands given as examples.
@end menu
@node Configuration format,Using taler-config,,How to configure the merchant’s backend
-@anchor{taler-merchant-manual configuration-format}@anchor{21}
+@anchor{taler-merchant-manual configuration-format}@anchor{22}
@section Configuration format
@@ -941,7 +1001,7 @@ merchant needs to know an exchange URL, or a database name.
@end quotation
@node Using taler-config,Backend options,Configuration format,How to configure the merchant’s backend
-@anchor{taler-merchant-manual using-taler-config}@anchor{22}
+@anchor{taler-merchant-manual using-taler-config}@anchor{23}
@section Using taler-config
@@ -994,7 +1054,7 @@ to @code{taler-merchant-httpd} and @code{taler-config} using the @code{-c}
option.
@node Backend options,Sample backend configuration,Using taler-config,How to configure the merchant’s backend
-@anchor{taler-merchant-manual backend-options}@anchor{23}@anchor{taler-merchant-manual id6}@anchor{24}
+@anchor{taler-merchant-manual backend-options}@anchor{24}@anchor{taler-merchant-manual id6}@anchor{25}
@section Backend options
@@ -1032,7 +1092,7 @@ modified. Here, the notation @code{[$section]/$option} denotes the option
@end menu
@node Service address,Currency,,Backend options
-@anchor{taler-merchant-manual service-address}@anchor{25}
+@anchor{taler-merchant-manual service-address}@anchor{26}
@subsection Service address
@@ -1071,7 +1131,7 @@ $ taler-config -s MERCHANT -o PORT -V 8888
@end example
@node Currency,Database,Service address,Backend options
-@anchor{taler-merchant-manual currency}@anchor{26}
+@anchor{taler-merchant-manual currency}@anchor{27}
@subsection Currency
@@ -1091,7 +1151,7 @@ $ taler-config -s TALER -o CURRENCY -V KUDOS
@end example
@node Database,Exchange,Currency,Backend options
-@anchor{taler-merchant-manual database}@anchor{27}
+@anchor{taler-merchant-manual database}@anchor{28}
@subsection Database
@@ -1160,7 +1220,7 @@ command-line option, send logging output to standard error by default.
@c index: MASTER_KEY
@node Exchange,Auditor,Database,Backend options
-@anchor{taler-merchant-manual exchange}@anchor{28}
+@anchor{taler-merchant-manual exchange}@anchor{29}
@subsection Exchange
@@ -1209,7 +1269,7 @@ currency from the “TALER” section, the exchange is ignored. If you need to
support multiple currencies, you need to configure a backend per currency.
@node Auditor,,Exchange,Backend options
-@anchor{taler-merchant-manual auditor}@anchor{29}
+@anchor{taler-merchant-manual auditor}@anchor{2a}
@subsection Auditor
@@ -1259,7 +1319,7 @@ currency from the “TALER” section, the auditor is ignored. If you need to
support multiple currencies, you need to configure a backend per currency.
@node Sample backend configuration,Launching the backend,Backend options,How to configure the merchant’s backend
-@anchor{taler-merchant-manual id7}@anchor{2a}@anchor{taler-merchant-manual sample-backend-configuration}@anchor{2b}
+@anchor{taler-merchant-manual id7}@anchor{2b}@anchor{taler-merchant-manual sample-backend-configuration}@anchor{2c}
@section Sample backend configuration
@@ -1306,7 +1366,7 @@ configuration steps, showing how to invoke @code{taler-config} for each of
them.
@node Launching the backend,,Sample backend configuration,How to configure the merchant’s backend
-@anchor{taler-merchant-manual id8}@anchor{2c}@anchor{taler-merchant-manual launching-the-backend}@anchor{2d}
+@anchor{taler-merchant-manual id8}@anchor{2d}@anchor{taler-merchant-manual launching-the-backend}@anchor{2e}
@section Launching the backend
@@ -1345,7 +1405,7 @@ and use TLS for improved network privacy, see @ref{9,,Secure setup}.
@geindex instance
@node Instance setup,Secure setup,How to configure the merchant’s backend,Top
-@anchor{taler-merchant-manual id9}@anchor{2e}@anchor{taler-merchant-manual instance-setup}@anchor{2f}
+@anchor{taler-merchant-manual id9}@anchor{2f}@anchor{taler-merchant-manual instance-setup}@anchor{30}
@chapter Instance setup
@@ -1359,7 +1419,7 @@ Before using the backend, you must at least configure the “default” instance
@end menu
@node KUDOS Accounts,IBAN Accounts,,Instance setup
-@anchor{taler-merchant-manual kudos-accounts}@anchor{30}
+@anchor{taler-merchant-manual kudos-accounts}@anchor{31}
@section KUDOS Accounts
@@ -1380,7 +1440,7 @@ must be replaced with the name of the account that was established
at @indicateurl{https://bank.demo.taler.net/}.
@node IBAN Accounts,Setup,KUDOS Accounts,Instance setup
-@anchor{taler-merchant-manual iban-accounts}@anchor{31}
+@anchor{taler-merchant-manual iban-accounts}@anchor{32}
@section IBAN Accounts
@@ -1392,7 +1452,7 @@ IBAN, the corresponding payto://-URI is simply “payto://iban/$IBAN” where
“$IBAN” must be replaced with the actual IBAN number.
@node Setup,,IBAN Accounts,Instance setup
-@anchor{taler-merchant-manual setup}@anchor{32}
+@anchor{taler-merchant-manual setup}@anchor{33}
@section Setup
@@ -1440,7 +1500,7 @@ or purge (deleting all associated data) instances exist as well and are document
in the Merchant Backend API documentation.
@node Secure setup,Customization,Instance setup,Top
-@anchor{taler-merchant-manual id11}@anchor{33}@anchor{taler-merchant-manual secure-setup}@anchor{9}
+@anchor{taler-merchant-manual id11}@anchor{34}@anchor{taler-merchant-manual secure-setup}@anchor{9}
@chapter Secure setup
@@ -1462,7 +1522,7 @@ authentication and then forwards requests to the backend.
@end menu
@node Using UNIX domain sockets,Reverse proxy configuration,,Secure setup
-@anchor{taler-merchant-manual using-unix-domain-sockets}@anchor{34}
+@anchor{taler-merchant-manual using-unix-domain-sockets}@anchor{35}
@section Using UNIX domain sockets
@@ -1484,7 +1544,7 @@ but this is @emph{not recommended}. Relying on NAT or network firewalls for acc
control is gross negligence.
@node Reverse proxy configuration,Access control,Using UNIX domain sockets,Secure setup
-@anchor{taler-merchant-manual reverse-proxy-configuration}@anchor{35}
+@anchor{taler-merchant-manual reverse-proxy-configuration}@anchor{36}
@section Reverse proxy configuration
@@ -1495,7 +1555,7 @@ control is gross negligence.
@end menu
@node Nginx,Apache,,Reverse proxy configuration
-@anchor{taler-merchant-manual nginx}@anchor{36}
+@anchor{taler-merchant-manual nginx}@anchor{37}
@subsection Nginx
@@ -1515,7 +1575,7 @@ not have HTTPS enabled. Make sure to restart the @code{taler-merchant-httpd}
process after changing the @code{SERVE} configuration.
@node Apache,,Nginx,Reverse proxy configuration
-@anchor{taler-merchant-manual apache}@anchor{37}
+@anchor{taler-merchant-manual apache}@anchor{38}
@subsection Apache
@@ -1546,7 +1606,7 @@ The above configuration(s) are both incomplete. You must still additionally
setup access control!
@node Access control,,Reverse proxy configuration,Secure setup
-@anchor{taler-merchant-manual access-control}@anchor{38}
+@anchor{taler-merchant-manual access-control}@anchor{39}
@section Access control
@@ -1571,7 +1631,7 @@ endpoints directly without client authentication.
@end menu
@node Nginx<2>,Apache<2>,,Access control
-@anchor{taler-merchant-manual id12}@anchor{39}
+@anchor{taler-merchant-manual id12}@anchor{3a}
@subsection Nginx
@@ -1622,7 +1682,7 @@ location ~ /private/ @{
@end example
@node Apache<2>,,Nginx<2>,Access control
-@anchor{taler-merchant-manual id13}@anchor{3a}
+@anchor{taler-merchant-manual id13}@anchor{3b}
@subsection Apache
@@ -1691,7 +1751,7 @@ System admininistrators are strongly advised to test their access control
setup before going into production!
@node Customization,Upgrade procedure,Secure setup,Top
-@anchor{taler-merchant-manual customization}@anchor{3b}
+@anchor{taler-merchant-manual customization}@anchor{3c}
@chapter Customization
@@ -1704,7 +1764,7 @@ setup before going into production!
@end menu
@node Templates,Static files,,Customization
-@anchor{taler-merchant-manual templates}@anchor{3c}
+@anchor{taler-merchant-manual templates}@anchor{3d}
@section Templates
@@ -1714,7 +1774,7 @@ own design. The templating language used is Mustach, and the templates
are in the @code{share/taler/merchant/templates/} directory.
@node Static files,Internationalization,Templates,Customization
-@anchor{taler-merchant-manual static-files}@anchor{3d}
+@anchor{taler-merchant-manual static-files}@anchor{3e}
@section Static files
@@ -1724,7 +1784,7 @@ logic to load a CSS file, but you can also put other resources such as
images or JavaScript.
@node Internationalization,Limitations,Static files,Customization
-@anchor{taler-merchant-manual internationalization}@anchor{3e}
+@anchor{taler-merchant-manual internationalization}@anchor{3f}
@section Internationalization
@@ -1741,7 +1801,7 @@ returned. Otherwise, an internationalized file based on the language
preferences indicated by the browser is returned.
@node Limitations,,Internationalization,Customization
-@anchor{taler-merchant-manual limitations}@anchor{3f}
+@anchor{taler-merchant-manual limitations}@anchor{40}
@section Limitations
@@ -1759,7 +1819,7 @@ template expansion, and does not make use of scopes and other Mustach
features.
@node Upgrade procedure,Tipping visitors,Customization,Top
-@anchor{taler-merchant-manual upgrade-procedure}@anchor{40}
+@anchor{taler-merchant-manual upgrade-procedure}@anchor{41}
@chapter Upgrade procedure
@@ -1791,7 +1851,7 @@ $ taler-merchant-httpd
@end example
@node Tipping visitors,Advanced topics,Upgrade procedure,Top
-@anchor{taler-merchant-manual id14}@anchor{41}@anchor{taler-merchant-manual tipping-visitors}@anchor{42}
+@anchor{taler-merchant-manual id14}@anchor{42}@anchor{taler-merchant-manual tipping-visitors}@anchor{43}
@chapter Tipping visitors
@@ -1813,7 +1873,7 @@ There are three basic steps that must happen to tip a visitor.
@end menu
@node Fund the reserve,Authorize a tip,,Tipping visitors
-@anchor{taler-merchant-manual fund-the-reserve}@anchor{43}@anchor{taler-merchant-manual id15}@anchor{44}
+@anchor{taler-merchant-manual fund-the-reserve}@anchor{44}@anchor{taler-merchant-manual id15}@anchor{45}
@section Fund the reserve
@@ -1863,7 +1923,7 @@ initially. If your campaign runs longer, you should setup another reserve
every other week to ensure one is always ready.
@node Authorize a tip,Picking up of the tip,Fund the reserve,Tipping visitors
-@anchor{taler-merchant-manual authorize-a-tip}@anchor{45}@anchor{taler-merchant-manual id16}@anchor{46}
+@anchor{taler-merchant-manual authorize-a-tip}@anchor{46}@anchor{taler-merchant-manual id16}@anchor{47}
@section Authorize a tip
@@ -1903,7 +1963,7 @@ The frontend should handle errors returned by the backend, such as
misconfigured instances or a lack of remaining funds for tipping.
@node Picking up of the tip,,Authorize a tip,Tipping visitors
-@anchor{taler-merchant-manual id17}@anchor{47}@anchor{taler-merchant-manual picking-up-of-the-tip}@anchor{48}
+@anchor{taler-merchant-manual id17}@anchor{48}@anchor{taler-merchant-manual picking-up-of-the-tip}@anchor{49}
@section Picking up of the tip
@@ -1913,7 +1973,7 @@ The frontend must then forward this request to the backend. The response
generated by the backend can then be forwarded directly to the wallet.
@node Advanced topics,Advanced experimental features,Tipping visitors,Top
-@anchor{taler-merchant-manual advanced-topics}@anchor{49}
+@anchor{taler-merchant-manual advanced-topics}@anchor{4a}
@chapter Advanced topics
@@ -1924,7 +1984,7 @@ generated by the backend can then be forwarded directly to the wallet.
@end menu
@node Database Scheme,Configuration format<2>,,Advanced topics
-@anchor{taler-merchant-manual database-scheme}@anchor{4a}@anchor{taler-merchant-manual merchantdatabasescheme}@anchor{4b}
+@anchor{taler-merchant-manual database-scheme}@anchor{4b}@anchor{taler-merchant-manual merchantdatabasescheme}@anchor{4c}
@section Database Scheme
@@ -1940,7 +2000,7 @@ The database scheme used by the merchant looks as follows:
@image{taler-merchant-figures/merchant-db,,,,png}
@node Configuration format<2>,,Database Scheme,Advanced topics
-@anchor{taler-merchant-manual id18}@anchor{4c}
+@anchor{taler-merchant-manual id18}@anchor{4d}
@section Configuration format
@@ -2022,7 +2082,7 @@ merchant needs to know an exchange URL, or a database name.
@end menu
@node Using taler-config<2>,,,Configuration format<2>
-@anchor{taler-merchant-manual id19}@anchor{4d}@anchor{taler-merchant-manual using-taler-002dconfig}@anchor{4e}
+@anchor{taler-merchant-manual id19}@anchor{4e}@anchor{taler-merchant-manual using-taler-002dconfig}@anchor{4f}
@subsection Using taler-config
@@ -2077,7 +2137,7 @@ to @code{taler-merchant-httpd} and @code{taler-config} using the @code{-c}
option.
@node Advanced experimental features,Temporarily Abandoned Features,Advanced topics,Top
-@anchor{taler-merchant-manual advanced-experimental-features}@anchor{4f}
+@anchor{taler-merchant-manual advanced-experimental-features}@anchor{50}
@chapter Advanced experimental features
@@ -2092,7 +2152,7 @@ need, or will not need initially.
@end menu
@node Benchmarking,Benchmark setup,,Advanced experimental features
-@anchor{taler-merchant-manual benchmarking}@anchor{50}@anchor{taler-merchant-manual merchantbenchmarking}@anchor{51}
+@anchor{taler-merchant-manual benchmarking}@anchor{51}@anchor{taler-merchant-manual merchantbenchmarking}@anchor{52}
@section Benchmarking
@@ -2114,7 +2174,7 @@ to customize the benchmark and/or to cover more realistic workloads from the
start.
@node Benchmark setup,Running the benchmark command,Benchmarking,Advanced experimental features
-@anchor{taler-merchant-manual benchmark-setup}@anchor{52}
+@anchor{taler-merchant-manual benchmark-setup}@anchor{53}
@section Benchmark setup
@@ -2263,18 +2323,11 @@ 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, usually by running
-
-@example
-$ taler-exchange-wire -c $CONFIG_FILE
-$ taler-exchange-keyup -c $CONFIG_FILE
-@end example
-
-where “$CONFIG_FILE” should be replaced by
-the configuration file that is to be used.
+details are setup.
+For details, see the Exchange Operator Manual.
@node Running the benchmark command,,Benchmark setup,Advanced experimental features
-@anchor{taler-merchant-manual running-the-benchmark-command}@anchor{53}
+@anchor{taler-merchant-manual running-the-benchmark-command}@anchor{54}
@section Running the benchmark command
@@ -2346,7 +2399,7 @@ actual measurement of performance is provided (despite of the
@end itemize
@node Temporarily Abandoned Features,Index,Advanced experimental features,Top
-@anchor{taler-merchant-manual temporarily-abandoned-features}@anchor{54}
+@anchor{taler-merchant-manual temporarily-abandoned-features}@anchor{55}
@chapter Temporarily Abandoned Features
@@ -2356,7 +2409,7 @@ actual measurement of performance is provided (despite of the
@end menu
@node Installing Taler using Docker,,,Temporarily Abandoned Features
-@anchor{taler-merchant-manual installing-taler-using-docker}@anchor{55}
+@anchor{taler-merchant-manual installing-taler-using-docker}@anchor{56}
@section Installing Taler using Docker