[GNUnet-SVN] [taler-backoffice] 01/02: configuration explained

[gnunet]

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

marcello pushed a commit to branch master
in repository backoffice.

commit 238857d7645996768134cf630a7d0a143238bed2
Author: Marcello Stanisci <address@hidden>
AuthorDate: Wed Jan 17 14:07:22 2018 +0100

    configuration explained
---
 doc/manual.texi | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 99 insertions(+), 2 deletions(-)

diff --git a/doc/manual.texi b/doc/manual.texi
index c19f381..7f8d5fc 100644
--- a/doc/manual.texi
+++ b/doc/manual.texi
@@ -50,12 +50,109 @@ Texts.  A copy of the license is included in the section 
entitled
 @end ifnottex
 
 @menu
-* Introduction::                           What servives the Web application 
provides.
+* 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.
 @end menu
 
 @node Introduction
 @chapter Introduction
 
-TBD.
+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.
+
+This manual will guide the merchant through the installation and configuration
+of this Web application.
+
address@hidden Installation
address@hidden Installation
+
+The back-office Web application code is available at the repository:
address@hidden://taler.net/backoffice}.  The application can be installed
+in a GNU-ish fashion.
+
address@hidden
+# Get the code:
+$ git clone git://taler.net/backoffice
+
+# Bootstrap and configure
+$ cd backoffice
+$ ./bootstrap
+# This step will check if the system is ready to
+# allow the installation.
+$ ./configure --prefix=<PFX>
+$ make install
address@hidden 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.
+
address@hidden
address@hidden
+
+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 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.
+
+Assuming the reader is familiar with configuration in Taler (if not, read:
address@hidden://docs.taler.net/exchange/html/taler-exchange.html#Configuration-format}),
+a working configuration example is the following one:
+
address@hidden
+
+[taler]
+# will be EUR, USD, or whatever currency the merchant
+# works with.
+currency = KUDOS
+
+# each back-office Web application is associated with a "frontend
+# name": this name instructs the application which configuration
+# section is going to be read.  Thus <name> is the "frontend name"
+# and must be specified on the command line via the "--frontend"
+# option.  See the 'Run' chapter for more details on launching the
+# application.
+[backoffice-<name>]
+
+# <how> can be 'html' or 'uwsgi', so as to serve the Web site
+# via HTTP or WSGI.
+uwsgi_serve = <how>
+
+# those options will be read if the Web site is served via
+# WSGI.
+uwsgi_unixpath_mode = 660
+uwsgi_unixpath = /path/to/backoffice-<name>.uwsgi
+uwsgi_unixmode = 666
+
+# this option will be read if the Web site is served via
+# HTTP.
+http_port = 5959
+
+# specifies which merchant backend is going to be used.
+backend = http://backend.test.taler.net/
+
+# FIXME: put instance link.  This link does not exist yet; only
+# the merchant manual has some paragraph about this subject, but
+# it is not directly linkable.
+
+# Informally speaking, each instance points to both a private
+# key that can sign proposals and a bank account that can receive
+# wire transfers by some exchange.
+
+# Please see <..> for more information about instances.
+
+# Here, <instance_i> is just a string (with no spaces) that will
+# make the referenced instance be traceable by the back-office Web
+# application.
+
+instances = <instance_1> <instance_2> ..
address@hidden example
 
 @bye

-- 
To stop receiving notification emails like this one, please contact
address@hidden