diff options
author | Marcello Stanisci <stanisci.m@gmail.com> | 2018-01-17 14:07:22 +0100 |
---|---|---|
committer | Marcello Stanisci <stanisci.m@gmail.com> | 2018-01-17 14:07:22 +0100 |
commit | 238857d7645996768134cf630a7d0a143238bed2 (patch) | |
tree | 8d168385afd3e5a07986827664495a6f8966fe70 | |
parent | 42b47508ea188c829ab7cd7deb15c0afb21fb9e6 (diff) | |
download | backoffice-238857d7645996768134cf630a7d0a143238bed2.tar.gz backoffice-238857d7645996768134cf630a7d0a143238bed2.tar.bz2 backoffice-238857d7645996768134cf630a7d0a143238bed2.zip |
configuration explained
-rw-r--r-- | doc/manual.texi | 101 |
1 files 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. + +@node Installation +@chapter Installation + +The back-office Web application code is available at the repository: +@code{git://taler.net/backoffice}. The application can be installed +in a GNU-ish fashion. + +@example +# 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 +@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. + +@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 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: +@code{https://docs.taler.net/exchange/html/taler-exchange.html#Configuration-format}), +a working configuration example is the following one: + +@example + +[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> .. +@end example @bye |