taler-docs

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

index.rst (3576B)


      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 2.1, 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 
     72 .. toctree::
     73   :maxdepth: 1
     74   :hidden:
     75   :numbered:
     76   :caption: For Bank Integrators
     77 
     78   libeufin/index
     79   taler-magnet-bank-manual
     80   taler-cyclos-manual
     81   depolymerization/index
     82 
     83 .. toctree::
     84   :maxdepth: 1
     85   :hidden:
     86   :numbered:
     87   :caption: For Regional and Event Currencies
     88 
     89   regional/regional-automated-manual.rst
     90   regional/regional-custom-manual.rst
     91   regional/regional-manual-use.rst
     92 
     93 .. toctree::
     94   :maxdepth: 1
     95   :hidden:
     96   :numbered:
     97   :caption: For Other Operators
     98 
     99   taler-auditor-manual
    100   taler-directory-manual
    101   taler-mailbox-manual
    102 
    103 .. toctree::
    104   :maxdepth: 1
    105   :hidden:
    106   :numbered:
    107   :caption: For Developers
    108 
    109   core/index
    110   developer/index
    111   design-documents/index
    112 
    113 
    114 .. toctree::
    115   :maxdepth: 1
    116   :hidden:
    117   :numbered:
    118   :caption: For System Administrators
    119 
    120   manindex
    121   system-administration/index
    122   deployments/index
    123 
    124 .. toctree::
    125   :maxdepth: 1
    126   :hidden:
    127   :numbered:
    128   :caption: For Lawyers
    129 
    130   global-licensing
    131   fdl-1.3
    132 
    133 .. toctree::
    134    :hidden:
    135    :caption: Other
    136 
    137    genindex
    138