commit 0387814723b3c3d055153892e98b9ed6db7a1450 parent 79a8adba0386900dc7b4ca238fe1d36235ff4e61 Author: Marcello Stanisci <marcello.stanisci@inria.fr> Date: Mon, 26 Dec 2016 18:42:18 +0100 Still on splitting Diffstat:
30 files changed, 237 insertions(+), 168 deletions(-)
diff --git a/Makefile b/Makefile @@ -16,7 +16,7 @@ endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(PWD)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . @@ -54,41 +54,41 @@ clean: # The html-linked builder does not support caching, so we # remove all cached state first. html: - $(SPHINXBUILD) -b html-linked $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/html - $(SPHINXBUILD) -b html-linked $(ALLSPHINXOPTS) $(APIBUILDDIR)/html + $(SPHINXBUILD) docs/ -b html-linked $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b html-linked $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The HTML pages are in $(APIBUILDDIR)/html." @echo "Build finished. The HTML pages are in $(DOCSBUILDDIR)/html." dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/dirhtml - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(APIBUILDDIR)/dirhtml + $(SPHINXBUILD) docs/ -b dirhtml $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b dirhtml $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The HTML pages are in $(APIBUILDDIR)/dirhtml." @echo "Build finished. The HTML pages are in $(DOCSBUILDDIR)/dirhtml." singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/singlehtml - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(APIBUILDDIR)/singlehtml + $(SPHINXBUILD) docs/ -b singlehtml $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b singlehtml $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The HTML page is in $(DOCSBUILDDIR)/singlehtml." @echo "Build finished. The HTML page is in $(APIBUILDDIR)/singlehtml." pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(APIBUILDDIR)/pickle - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/pickle + $(SPHINXBUILD) api/ -b pickle $(ALLSPHINXOPTS) $(APIBUILDDIR) + $(SPHINXBUILD) docs/ -b pickle $(ALLSPHINXOPTS) $(DOCSBUILDDIR) @echo @echo "Build finished; now you can process the pickle files." json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/json - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(APIBUILDDIR)/json + $(SPHINXBUILD) docs/ -b json $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b json $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/htmlhelp - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(APIBUILDDIR)/htmlhelp + $(SPHINXBUILD) docs/ -b htmlhelp $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b htmlhelp $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(DOCSBUILDDIR)/htmlhelp." @@ -96,8 +96,8 @@ htmlhelp: ".hhp project file in $(APIBUILDDIR)/htmlhelp." qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/qthelp - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(APIBUILDDIR)/qthelp + $(SPHINXBUILD) docs/ -b qthelp $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b qthelp $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(DOCSBUILDDIR)/qthelp, like this:" @@ -112,8 +112,8 @@ qthelp: devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(APIBUILDDIR)/devhelp - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/devhelp + $(SPHINXBUILD) api/ -b devhelp $(ALLSPHINXOPTS) $(APIBUILDDIR) + $(SPHINXBUILD) docs/ -b devhelp $(ALLSPHINXOPTS) $(DOCSBUILDDIR) @echo @echo "Build finished." @echo "To view the help file:" @@ -123,15 +123,15 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(APIBUILDDIR)/epub - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/epub + $(SPHINXBUILD) api/ -b epub $(ALLSPHINXOPTS) $(APIBUILDDIR) + $(SPHINXBUILD) docs/ -b epub $(ALLSPHINXOPTS) $(DOCSBUILDDIR) @echo @echo "Build finished. The epub file is in $(APIBUILDDIR)/epub." @echo "Build finished. The epub file is in $(DOCSBUILDDIR)/epub." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(APIBUILDDIR)/latex - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/latex + $(SPHINXBUILD) api/ -b latex $(ALLSPHINXOPTS) $(APIBUILDDIR) + $(SPHINXBUILD) docs/ -b latex $(ALLSPHINXOPTS) $(DOCSBUILDDIR) @echo @echo "Build finished; the LaTeX files are in $(APIBUILDDIR)/latex." @echo "Build finished; the LaTeX files are in $(DOCSBUILDDIR)/latex." @@ -139,8 +139,8 @@ latex: "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(APIBUILDDIR)/latex - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/latex + $(SPHINXBUILD) api/ -b latex $(ALLSPHINXOPTS) $(APIBUILDDIR) + $(SPHINXBUILD) docs/ -b latex $(ALLSPHINXOPTS) $(DOCSBUILDDIR) @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(DOCSBUILDDIR)/latex all-pdf $(MAKE) -C $(APIBUILDDIR)/latex all-pdf @@ -148,8 +148,8 @@ latexpdf: @echo "pdflatex finished; the PDF files are in $(DOCSBUILDDIR)/latex." latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/latex - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(APIBUILDDIR)/latex + $(SPHINXBUILD) docs/ -b latex $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b latex $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(APIBUILDDIR)/latex all-pdf-ja $(MAKE) -C $(DOCSBUILDDIR)/latex all-pdf-ja @@ -157,22 +157,22 @@ latexpdfja: @echo "pdflatex finished; the PDF files are in $(APIBUILDDIR)/latex." text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/text - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(APIBUILDDIR)/text + $(SPHINXBUILD) docs/ -b text $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b text $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The text files are in $(DOCSBUILDDIR)/text." @echo "Build finished. The text files are in $(APIBUILDDIR)/text." man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/man - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(APIBUILDDIR)/man + $(SPHINXBUILD) docs/ -b man $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b man $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The manual pages are in $(DOCSBUILDDIR)/man." @echo "Build finished. The manual pages are in $(APIBUILDDIR)/man." texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/texinfo - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(APIBUILDDIR)/texinfo + $(SPHINXBUILD) docs/ -b texinfo $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b texinfo $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The Texinfo files are in $(DOCSBUILDDIR)/texinfo." @echo "Build finished. The Texinfo files are in $(APIBUILDDIR)/texinfo." @@ -180,8 +180,8 @@ texinfo: "(use \`make info' here to do that automatically)." info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/texinfo - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(APIBUILDDIR)/texinfo + $(SPHINXBUILD) docs/ -b texinfo $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b texinfo $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo "Running Texinfo files through makeinfo..." make -C $(DOCSBUILDDIR)/texinfo info make -C $(APIBUILDDIR)/texinfo info @@ -189,22 +189,22 @@ info: @echo "makeinfo finished; the Info files are in $(APIBUILDDIR)/texinfo." gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(DOCSBUILDDIR)/locale - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(APIBUILDDIR)/locale + $(SPHINXBUILD) docs/ -b gettext $(I18NSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b gettext $(I18NSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The message catalogs are in $(DOCSBUILDDIR)/locale." @echo "Build finished. The message catalogs are in $(APIBUILDDIR)/locale." changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/changes - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(APIBUILDDIR)/changes + $(SPHINXBUILD) docs/ -b changes $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b changes $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "The overview file is in $(DOCSBUILDDIR)/changes." @echo "The overview file is in $(APIBUILDDIR)/changes." linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/linkcheck - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(APIBUILDDIR)/linkcheck + $(SPHINXBUILD) docs/ -b linkcheck $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b linkcheck $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(APIBUILDDIR)/linkcheck/output.txt." @@ -213,8 +213,8 @@ linkcheck: doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/doctest - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(APIBUILDDIR)/doctest + $(SPHINXBUILD) docs/ -b doctest $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b doctest $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo "Testing of doctests in the sources finished, look at the " \ "results in $(APIBUILDDIR)/doctest/output.txt." @echo "Testing of doctests in the sources finished, look at the " \ @@ -222,15 +222,15 @@ doctest: xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/xml - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(APIBUILDDIR)/xml + $(SPHINXBUILD) docs/ -b xml $(ALLSPHINXOPTS) $(DOCSBUILDDIR) + $(SPHINXBUILD) api/ -b xml $(ALLSPHINXOPTS) $(APIBUILDDIR) @echo @echo "Build finished. The XML files are in $(DOCSBUILDDIR)/xml." @echo "Build finished. The XML files are in $(APIBUILDDIR)/xml." pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(APIBUILDDIR)/pseudoxml - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(DOCSBUILDDIR)/pseudoxml + $(SPHINXBUILD) api/ -b pseudoxml $(ALLSPHINXOPTS) $(APIBUILDDIR) + $(SPHINXBUILD) docs/ -b pseudoxml $(ALLSPHINXOPTS) $(DOCSBUILDDIR) @echo @echo "Build finished. The pseudo-XML files are in $(DOCSBUILDDIR)/pseudoxml." @echo "Build finished. The pseudo-XML files are in $(APIBUILDDIR)/pseudoxml." diff --git a/api-bank.rst b/api/api-bank.rst diff --git a/api-common.rst b/api/api-common.rst diff --git a/api-error.rst b/api/api-error.rst diff --git a/api-exchange.rst b/api/api-exchange.rst diff --git a/api-merchant.rst b/api/api-merchant.rst diff --git a/conf.py b/api/conf.py diff --git a/api/exts/__pycache__/tsref.cpython-35.pyc b/api/exts/__pycache__/tsref.cpython-35.pyc Binary files differ. diff --git a/exts/tsref.py b/api/exts/tsref.py diff --git a/global_licensing.rst b/api/global_licensing.rst diff --git a/api/index.rst b/api/index.rst @@ -0,0 +1,89 @@ +.. + This file is part of GNU TALER. + Copyright (C) 2014, 2015, 2016 GNUnet e.V. + + TALER is free software; you can redistribute it and/or modify it under the + terms of the GNU General Public License as published by the Free Software + Foundation; either version 2.1, or (at your option) any later version. + + TALER is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License along with + TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> + + @author Florian Dold + @author Benedikt Muller + @author Sree Harsha Totakura + +GNU Taler Documentation +======================= + +We are building an anonymous, taxable payment system using modern +cryptography. Customers will use traditional money transfers to send +money to a digital Exchange and in return receive (anonymized) digital +cash. Customers can use this digital cash to anonymously pay +Merchants. Merchants can redeem the digital cash for traditional +money at the digital Exchange. As Merchants are not anonymous, they can +be taxed, enabling income or sales taxes to be withheld by the state +while providing anonymity for Customers. + +Cryptography is used to ensure that none of the participants can +defraud the others without being detected immediately; however, in +practice a fradulent Exchange might go bankrupt instead of paying the +Merchants and thus the Exchange will need to be audited regularly like +any other banking institution. + +The system will be based on free software and open protocols. + +In this document, we describe the REST-based APIs between the various +components, internal architecture of key components, and how to get them +installed. + +------- +Preface +------- + +The *Operator Handbook* is for people who want to run a exchange or a merchant. +It focuses on how to install, configure and run the required software. + +.. toctree:: + :maxdepth: 2 + + global_licensing + versioning + +------------------------ +Web Integration Handbook +------------------------ + +The *Web Integration Handbook* is for those who want to interact with Taler +wallets on their own website. Integrators will also have to be familiar with +the material covered in the *Operator Handbook*. + + +.. toctree:: + :maxdepth: 2 + + integration-general + integration-bank + integration-merchant + +-------------------------------------- +Taler HTTP Core Protocol Specification +-------------------------------------- + +The *Protocol Specification* defines the HTTP-based, predominantly RESTful +interfaces between the core components of Taler. + +.. toctree:: + :maxdepth: 2 + + api-common + api-error + api-exchange + api-merchant + api-bank + + wireformats diff --git a/integration-bank.rst b/api/integration-bank.rst diff --git a/integration-general.rst b/api/integration-general.rst diff --git a/integration-merchant.rst b/api/integration-merchant.rst diff --git a/wireformats.rst b/api/wireformats.rst diff --git a/conf.py b/docs/conf.py diff --git a/configuration-basics.rst b/docs/configuration-basics.rst diff --git a/deployment.rst b/docs/deployment.rst diff --git a/dev-exchange.rst b/docs/dev-exchange.rst diff --git a/dev-merchant.rst b/docs/dev-merchant.rst diff --git a/dev-wallet-wx.rst b/docs/dev-wallet-wx.rst diff --git a/example-essay-store.rst b/docs/example-essay-store.rst diff --git a/docs/exts/__pycache__/tsref.cpython-35.pyc b/docs/exts/__pycache__/tsref.cpython-35.pyc Binary files differ. diff --git a/exts/tsref.py b/docs/exts/tsref.py diff --git a/global_licensing.rst b/docs/global_licensing.rst diff --git a/glossary.rst b/docs/glossary.rst diff --git a/docs/index.rst b/docs/index.rst @@ -0,0 +1,103 @@ +.. + This file is part of GNU TALER. + Copyright (C) 2014, 2015, 2016 GNUnet e.V. + + TALER is free software; you can redistribute it and/or modify it under the + terms of the GNU General Public License as published by the Free Software + Foundation; either version 2.1, or (at your option) any later version. + + TALER is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License along with + TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> + + @author Florian Dold + @author Benedikt Muller + @author Sree Harsha Totakura + +GNU Taler Documentation +======================= + +We are building an anonymous, taxable payment system using modern +cryptography. Customers will use traditional money transfers to send +money to a digital Exchange and in return receive (anonymized) digital +cash. Customers can use this digital cash to anonymously pay +Merchants. Merchants can redeem the digital cash for traditional +money at the digital Exchange. As Merchants are not anonymous, they can +be taxed, enabling income or sales taxes to be withheld by the state +while providing anonymity for Customers. + +Cryptography is used to ensure that none of the participants can +defraud the others without being detected immediately; however, in +practice a fradulent Exchange might go bankrupt instead of paying the +Merchants and thus the Exchange will need to be audited regularly like +any other banking institution. + +The system will be based on free software and open protocols. + +In this document, we describe the REST-based APIs between the various +components, internal architecture of key components, and how to get them +installed. + +----------------- +Operator Handbook +----------------- + +The *Operator Handbook* is for people who want to run a exchange or a merchant. +It focuses on how to install, configure and run the required software. + +.. toctree:: + :maxdepth: 2 + + global_licensing + configuration-basics + operate-exchange + operate-merchant + versioning + +------------------------ +Web Integration Handbook +------------------------ + +The *Web Integration Handbook* is for those who want to interact with Taler +wallets on their own website. Integrators will also have to be familiar with +the material covered in the *Operator Handbook*. + + +.. toctree:: + :maxdepth: 2 + + integration-general + integration-bank + integration-merchant + example-essay-store + +------------------ +Developer Handbook +------------------ + +The *Developer Handbook* brings developers up to speed who want to hack on the +core components of the Taler reference implementation. + +.. toctree:: + :maxdepth: 2 + + dev-wallet-wx + dev-exchange + dev-merchant + deployment.rst + releases.rst + +------------------ +Indices and tables +------------------ + +.. toctree:: + :hidden: + + glossary + +* :doc:`glossary` +* :ref:`search` diff --git a/operate-exchange.rst b/docs/operate-exchange.rst diff --git a/operate-merchant.rst b/docs/operate-merchant.rst diff --git a/index.rst b/index.rst @@ -1,123 +0,0 @@ -.. - This file is part of GNU TALER. - Copyright (C) 2014, 2015, 2016 GNUnet e.V. - - TALER is free software; you can redistribute it and/or modify it under the - terms of the GNU General Public License as published by the Free Software - Foundation; either version 2.1, or (at your option) any later version. - - TALER is distributed in the hope that it will be useful, but WITHOUT ANY - WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public License along with - TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> - - @author Florian Dold - @author Benedikt Muller - @author Sree Harsha Totakura - -GNU Taler Documentation -======================= - -We are building an anonymous, taxable payment system using modern -cryptography. Customers will use traditional money transfers to send -money to a digital Exchange and in return receive (anonymized) digital -cash. Customers can use this digital cash to anonymously pay -Merchants. Merchants can redeem the digital cash for traditional -money at the digital Exchange. As Merchants are not anonymous, they can -be taxed, enabling income or sales taxes to be withheld by the state -while providing anonymity for Customers. - -Cryptography is used to ensure that none of the participants can -defraud the others without being detected immediately; however, in -practice a fradulent Exchange might go bankrupt instead of paying the -Merchants and thus the Exchange will need to be audited regularly like -any other banking institution. - -The system will be based on free software and open protocols. - -In this document, we describe the REST-based APIs between the various -components, internal architecture of key components, and how to get them -installed. - ------------------ -Operator Handbook ------------------ - -The *Operator Handbook* is for people who want to run a exchange or a merchant. -It focuses on how to install, configure and run the required software. - -.. toctree:: - :maxdepth: 2 - - global_licensing - configuration-basics - operate-exchange - operate-merchant - versioning - ------------------------- -Web Integration Handbook ------------------------- - -The *Web Integration Handbook* is for those who want to interact with Taler -wallets on their own website. Integrators will also have to be familiar with -the material covered in the *Operator Handbook*. - - -.. toctree:: - :maxdepth: 2 - - integration-general - integration-bank - integration-merchant - example-essay-store - - --------------------------------------- -Taler HTTP Core Protocol Specification --------------------------------------- - -The *Protocol Specification* defines the HTTP-based, predominantly RESTful -interfaces between the core components of Taler. - -.. toctree:: - :maxdepth: 2 - - api-common - api-error - api-exchange - api-merchant - api-bank - - wireformats - - ------------------- -Developer Handbook ------------------- - -The *Developer Handbook* brings developers up to speed who want to hack on the -core components of the Taler reference implementation. - -.. toctree:: - :maxdepth: 2 - - dev-wallet-wx - dev-exchange - dev-merchant - deployment.rst - releases.rst - ------------------- -Indices and tables ------------------- - -.. toctree:: - :hidden: - - glossary - -* :doc:`glossary` -* :ref:`search`