summaryrefslogtreecommitdiff
path: root/index.rst
blob: 73d4d8c8184f75e1336e8d0d9d835a7cf204f6ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
..
  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-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`