taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

index.rst (3677B)


      1 ..
      2   This file is part of GNU TALER.
      3   Copyright (C) 2014-2023 Taler Systems SA
      4 
      5   TALER is free software; you can redistribute it and/or modify it under the
      6   terms of the GNU Affero General Public License as published by the Free Software
      7   Foundation; either version 3.0, or (at your option) any later version.
      8 
      9   TALER is distributed in the hope that it will be useful, but WITHOUT ANY
     10   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
     11   A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.
     12 
     13   You should have received a copy of the GNU Affero General Public License along with
     14   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
     15 
     16   @author Florian Dold
     17   @author Benedikt Muller
     18   @author Sree Harsha Totakura
     19   @author Marcello Stanisci
     20   @author Christian Grothoff
     21   @author Javier Sepulveda
     22   @author Özgür Kesim
     23 
     24 =======================
     25 GNU Taler Documentation
     26 =======================
     27 
     28 We are building an anonymous, taxable payment system using modern
     29 cryptography.  Customers will use traditional money transfers to send
     30 money to a digital Exchange and in return receive (anonymized) digital
     31 cash.  Customers can use this digital cash to anonymously pay
     32 Merchants.  Merchants can redeem the digital cash for traditional
     33 money at the digital Exchange.  As Merchants are not anonymous, they can
     34 be taxed, enabling income or sales taxes to be withheld by the state
     35 while providing anonymity for Customers.
     36 
     37 Cryptography is used to ensure that none of the participants can
     38 defraud the others without being detected immediately; however, in
     39 practice a fraudulent Exchange might go bankrupt instead of paying the
     40 Merchants and thus the Exchange will need to be audited regularly like
     41 any other banking institution.
     42 
     43 The system is based on free software and open protocols.
     44 
     45 In this documentation, we describe the REST-based APIs between the various
     46 components, how to use the system, the internal architecture of key
     47 components, and how to get them installed and configured.
     48 
     49 Tutorials are available `here <https://tutorials.taler.net/>`_. They demonstrate installation steps, configuration options,
     50 and overall usage of the different Taler components in text and video formats.
     51 
     52 
     53 .. toctree::
     54   :maxdepth: 1
     55   :hidden:
     56   :numbered:
     57   :caption: For Exchange Operators
     58 
     59   taler-exchange-manual
     60   taler-kyc-manual
     61   taler-challenger-manual
     62 
     63 .. toctree::
     64   :maxdepth: 1
     65   :hidden:
     66   :numbered:
     67   :caption: For Merchant Operators
     68 
     69   taler-merchant-manual
     70   taler-merchant-pos-terminal
     71   pos-integration
     72   taler-paivana-manual
     73 
     74 .. toctree::
     75   :maxdepth: 1
     76   :hidden:
     77   :numbered:
     78   :caption: For Bank Integrators
     79 
     80   libeufin/index
     81   taler-magnet-bank-manual
     82   taler-cyclos-manual
     83   taler-wise-manual
     84   depolymerization/index
     85 
     86 .. toctree::
     87   :maxdepth: 1
     88   :hidden:
     89   :numbered:
     90   :caption: For Regional and Event Currencies
     91 
     92   regional/regional-automated-manual.rst
     93   regional/regional-custom-manual.rst
     94   regional/regional-manual-use.rst
     95 
     96 .. toctree::
     97   :maxdepth: 1
     98   :hidden:
     99   :numbered:
    100   :caption: For Other Operators
    101 
    102   taler-auditor-manual
    103   taler-directory-manual
    104   taler-mailbox-manual
    105   taler-apns-relay-manual
    106 
    107 .. toctree::
    108   :maxdepth: 1
    109   :hidden:
    110   :numbered:
    111   :caption: For Developers
    112 
    113   core/index
    114   wallet/index
    115   developer/index
    116   design-documents/index
    117 
    118 
    119 .. toctree::
    120   :maxdepth: 1
    121   :hidden:
    122   :numbered:
    123   :caption: For System Administrators
    124 
    125   manindex
    126   system-administration/index
    127   deployments/index
    128 
    129 .. toctree::
    130   :maxdepth: 1
    131   :hidden:
    132   :numbered:
    133   :caption: For Lawyers
    134 
    135   global-licensing
    136   fdl-1.3
    137 
    138 .. toctree::
    139    :hidden:
    140    :caption: Other
    141 
    142    genindex