[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [taler-backoffice] branch master updated: misc minor edits
From: |
gnunet |
Subject: |
[GNUnet-SVN] [taler-backoffice] branch master updated: misc minor edits to backoffice manual |
Date: |
Thu, 18 Jan 2018 18:39:52 +0100 |
This is an automated email from the git hooks/post-receive script.
grothoff pushed a commit to branch master
in repository backoffice.
The following commit(s) were added to refs/heads/master by this push:
new 1837ab8 misc minor edits to backoffice manual
1837ab8 is described below
commit 1837ab841bb5bb44cbbdef1c7be5a36dc43329d2
Author: Christian Grothoff <address@hidden>
AuthorDate: Thu Jan 18 18:39:50 2018 +0100
misc minor edits to backoffice manual
---
doc/manual.texi | 80 ++++++++++++++++++++++-----------------------------------
1 file changed, 31 insertions(+), 49 deletions(-)
diff --git a/doc/manual.texi b/doc/manual.texi
index 0a3e24f..fa46198 100644
--- a/doc/manual.texi
+++ b/doc/manual.texi
@@ -13,7 +13,7 @@
@copying
Howtos for taler.net admins and developers (version @value{VERSION},
@value{UPDATED}),
-Copyright @copyright{} 2017-2018 Taler Systems SA & INRIA.
+Copyright @copyright{} 2017-2018 Taler Systems SA.
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -35,6 +35,7 @@ Texts. A copy of the license is included in the section
entitled
@subtitle Version @value{VERSION}
@subtitle @value{UPDATED}
@author Marcello Stanisci (@email{marcello@@taler.net})
address@hidden Christian Grothoff (@email{grothoff@@taler.net})
@page
@vskip 0pt plus 1filll
@insertcopying
@@ -53,23 +54,25 @@ Texts. A copy of the license is included in the section
entitled
* Introduction:: What services the Web application
provides.
* Installation:: Where to find the code and how to
install it.
* Configuration:: How to configure the Web
application.
-* Run:: How to run the Web application.
+* Launching the backoffice:: How to run the Web application.
@end menu
@node Introduction
@chapter Introduction
-The back-office Web application let the merchant check whether their
-Taler transactions were payed back by a wire transfer, and viceversa:
-which transactions correspond to a given wire transfer.
+The back-office Web application allows a merchant to check on the status
+of their Taler transactions. Merchants can check if and when they were
+paid by a wire transfer for coins deposited at the exchange. Also, given
+a wire transfer they have received, they can ask which Taler transactions
+correspond to the wire transfer.
-This manual will guide the merchant through the installation and configuration
-of this Web application.
+This manual guides merchant system administrators through the
+installation and configuration of this Web service.
@node Installation
@chapter Installation
-The back-office Web application code is available at the repository:
+The back-office Web application code is available at
@code{git://taler.net/backoffice}. The application can be installed
in a GNU-ish fashion.
@@ -82,28 +85,31 @@ $ cd backoffice
$ ./bootstrap
# This step will check if the system is ready to
# allow the installation.
-$ ./configure --prefix=<PFX>
+$ ./configure --prefix=<PREFIX>
$ make install
@end example
-Note: @code{<PFX>/bin} must be included in the @code{$PATH},
-and @code{<PFX>/lib/python3.5/site-packages/} in @code{$PYTHONPATH}
-in order to make the application work.
+Note that to make the application work @code{<PREFIX>/bin} must be
+included in the @code{$PATH}, and
address@hidden<PREFIX>/lib/python3.5/site-packages/} in @code{$PYTHONPATH}.
+
@node Configuration
@chapter Configuration
-The following information must come from configuration: how to
-serve the Web site, which currency is used, and which merchant backend
-this Web application will work against.
+The following information be provided in the configuration: on which
+address the backend should serve the Web site, which currency is used,
+and which merchant backend this Web application will work with.
The merchant backend is an important agent, as it is responsible for
-returning all the informations about transactions and wire transfers
-(informally called "tracks"). Therefore, this Web application is merely
-a frontend for it.
+returning information about transactions and wire transfers. The
+backoffice Web application is merely a frontend for it. A separate
+manual (available at
address@hidden://docs.taler.net/merchant/backend/html/manual.html})
+describes the installation and configuration of the merchant backend.
Assuming the reader is familiar with configuration in Taler (if not, read:
address@hidden://docs.taler.net/exchange/html/taler-exchange.html#Configuration-format}),
address@hidden://docs.taler.net/exchange/html/taler-exchange.html#Configuration-format}),
a working configuration example is the following one:
@example
@@ -149,47 +155,23 @@ backend = http://backend.test.taler.net/
instances = <instance_1> <instance_2> ..
@end example
address@hidden Run
address@hidden Run
address@hidden Launching the backoffice
address@hidden Launching the backoffice
The following example shows how to run the Web application.
@example
# such invocation will work only if the configuration contains
-# a section called "[backoffice-animalshop]" which looks like the
+# a section called "[backoffice-myshop]" which looks like the
# example above.
# As of serving, the Web site will be available via HTTP, at the
# port specified in the configuration option "http_port", at localhost.
-$ taler-merchant-backoffice --frontend animalshop serve-http
+$ taler-merchant-backoffice --frontend myshop serve-http
@end example
-Other options - like e.g. serve the site via WSGI - are showed by the
-usual @code{--help} argument. Do
-
address@hidden
-$ taler-merchant-backoffice --help
-
-
-# Output:
-#
-# usage: taler-merchant-backoffice [-h] [--config CONFIG] --frontend FRONTEND
-# @{serve-http,address@hidden ...
-#
-# positional arguments:
-# @{serve-http,address@hidden
-# serve-http Serve over HTTP
-# serve-uwsgi Serve over UWSGI
-#
-# optional arguments:
-# -h, --help show this help message and exit
-# --config CONFIG, -c CONFIG
-# configuration file to use
-# --frontend FRONTEND, -f FRONTEND
-# fetch config values from [backoffice-<FRONTEND>]
-# section
-
address@hidden example
+Other options, such as those to serve the site via WSGI, are explained
+in the man page and can be listed using the @code{--help} argument.
@bye
--
To stop receiving notification emails like this one, please contact
address@hidden
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] [taler-backoffice] branch master updated: misc minor edits to backoffice manual,
gnunet <=