gnunet-svn
[Top][All Lists]
Advanced

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

[GNUnet-SVN] [taler-docs] branch master updated: pdf manuals / naming


From: gnunet
Subject: [GNUnet-SVN] [taler-docs] branch master updated: pdf manuals / naming
Date: Thu, 29 Aug 2019 15:23:01 +0200

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

dold pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 223f45c  pdf manuals / naming
223f45c is described below

commit 223f45cb0a0f21bdaddef46f1dbe144d8c231915
Author: Florian Dold <address@hidden>
AuthorDate: Thu Aug 29 15:22:58 2019 +0200

    pdf manuals / naming
---
 backoffice.rst | 155 ---------------------------------------------------------
 conf.py        |   4 +-
 index.rst      |   2 +-
 3 files changed, 4 insertions(+), 157 deletions(-)

diff --git a/backoffice.rst b/backoffice.rst
deleted file mode 100644
index 8dbfb16..0000000
--- a/backoffice.rst
+++ /dev/null
@@ -1,155 +0,0 @@
-Howtos for taler.net admins and developers (version 0.0.0, 16 Jan 2018),
-Copyright © 2017-2018 Taler Systems SA.
-
-   Permission is granted to copy, distribute and/or modify this document
-   under the terms of the GNU Free Documentation License, Version 1.3 or
-   any later version published by the Free Software Foundation; with no
-   Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-   Texts. A copy of the license is included in the section entitled “GNU
-   Free Documentation License”.
-
-.. _Top:
-
-Back-office Web service manual
-###############################
-
-Howtos for taler.net admins and developers (version 0.0.0, 16 Jan 2018),
-Copyright © 2017-2018 Taler Systems SA.
-
-   Permission is granted to copy, distribute and/or modify this document
-   under the terms of the GNU Free Documentation License, Version 1.3 or
-   any later version published by the Free Software Foundation; with no
-   Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-   Texts. A copy of the license is included in the section entitled “GNU
-   Free Documentation License”.
-
-.. _Introduction:
-
-Introduction
-============
-
-The back-office Web service 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 guides merchant system administrators through the
-installation and configuration of this Web service.
-
-.. _Installation:
-
-Installation
-============
-
-The back-office Web service code is available at
-``git://taler.net/backoffice``. The application can be installed in a
-GNU-ish fashion.
-
-::
-
-   # 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=<PREFIX>
-   $ make install
-
-Note that to make the application work ``<PREFIX>/bin`` must be included
-in the ``$PATH``, and ``<PREFIX>/lib/python3.5/site-packages/`` in
-``$PYTHONPATH``.
-
-.. _Configuration:
-
-Configuration
-=============
-
-The following information must 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 service will work with.
-
-The merchant backend is an important agent, as it is responsible for
-returning information about transactions and wire transfers. The
-backoffice Web service is merely a frontend for it. A separate manual
-(available at https://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:
-https://docs.taler.net/exchange/html/taler-exchange.html#Configuration-format),
-a working configuration example is the following one:
-
-::
-
-   [taler]
-   # will be EUR, USD, or whatever currency the merchant
-   # works with.
-   currency = KUDOS
-
-   # each back-office Web service 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>]
-
-   # This option sets the way the backoffice communicates
-   # when it is instructed to operate via UWSGI.  Therefore,
-   # <how> can be: TCP or UNIX.  If TCP is given, then the
-   # additional UWSGI_PORT option becomes necessary.
-   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
-
-   # If UWSGI_SERVE were set as 'TCP', then the following option
-   # would have been necessary.  It instructs the backoffice service
-   # about which TCP port should be listened on, to communicate over
-   # UWSGI.
-   # uwsgi_port = 8080
-
-   # 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/
-
-   # 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.
-
-   # 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> ..
-
-.. _Launching-the-backoffice:
-
-Launching the backoffice
-========================
-
-The following example shows how to run the Web service.
-
-::
-
-   # such invocation will work only if the configuration contains
-   # 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 myshop serve-http
-
-Other options, such as those to serve the site via WSGI, are explained
-in the man page and can be listed using the ``--help`` argument.
diff --git a/conf.py b/conf.py
index fa2030a..dd60067 100644
--- a/conf.py
+++ b/conf.py
@@ -227,7 +227,9 @@ latex_elements = {
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
   ('taler-exchange-manual', 'taler-exchange-manual.tex', 'GNU Taler Exchange 
Manual', 'GNU Taler team', 'manual'),
-  ('taler-merchant-manual', 'taler-merchant-manual.tex', 'GNU Taler Exchange 
Manual', 'GNU Taler team', 'manual'),
+  ('taler-merchant-manual', 'taler-merchant-manual.tex', 'GNU Taler Merchant 
Manual', 'GNU Taler team', 'manual'),
+  ('taler-bank-manual', 'taler-bank-manual.tex', 'GNU Taler Bank Manual', 'GNU 
Taler team', 'manual'),
+  ('taler-backoffice-manual', 'taler-backoffice-manual.tex', 'GNU Taler Back 
Office Manual', 'GNU Taler team', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
diff --git a/index.rst b/index.rst
index 1997b39..f2c3650 100644
--- a/index.rst
+++ b/index.rst
@@ -57,7 +57,7 @@ interfaces between the core components of Taler.
   taler-merchant-manual
   taler-merchant-api-tutorial
   taler-bank-manual
-  backoffice
+  taler-backoffice-manual
   onboarding
   global-licensing
 

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



reply via email to

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