aboutsummaryrefslogtreecommitdiff
path: root/README
blob: d3cde006552973202e395f4e5ea4334ba97b14aa (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
                       Welcome to GNU Taler


What is Taler?
==============

Taler is an electronic payment system providing the ability to pay
anonymously using digital cash.  Taler consists of a network protocol
definition (using a RESTful API over HTTP), a Donau (which creates
digital coins), a Wallet (which allows donors to manage, store and
spend digital coins), and a Charity website which allows donors to
spend their digital coins.  Naturally, each Charity is different, but
Taler includes code examples to help Charities integrate Taler as a
payment system.

Taler is currently developed by a worldwide group of independent free software
developers and Taler Systems SA.  Taler is free software and an official GNU
package (https://www.gnu.org/).

This is an alpha release with a few known bugs, lacking a few important
features, documentation, testing, performance tuning and an external security
audit.  However, you can run the code and it largely works fine.  This package
also only includes the Taler donau, not the other components of the system.

Documentation about Taler can be found at https://taler.net/.
Our bug tracker is at https://bugs.taler.net/.


Joining GNU
===========

This is a GNU program, developed by the GNU Project and part of the
GNU Operating System. If you are the author of an awesome program and
want to join us in writing Free Software, please consider making it an
official GNU program and become a GNU maintainer.  You can find
instructions on how to do so at http://www.gnu.org/help/evaluation.
We are looking forward to hacking with you!


Dependencies:
=============

These are the direct dependencies for running a Taler donau:

- GNUnet            >= 0.16.0
- GNU libmicrohttpd >= 0.9.71
- PostgreSQL        >= 13.0



Project structure is currently as follows:

src/include/
  -- installed headers for public APIs

src/util/
  -- common utility functions (currency representation,
     Taler-specific cryptography, Taler-specific json
     support)

src/pq/
  -- Postgres-specific utility functions

src/donaudb/
  -- Donau database backend (with database-specific plugins)

src/donau/
  -- taler donau server

src/donau-tools/
  -- taler donau helper programs

src/lib/
  -- libtalerdonau: C API to issue HTTP requests to donau

src/json/
  -- helper functions for generating and parsing JSON

src/mhd/
  -- helper functions for interacting with GNU libmicrohttpd

src/curl/
  -- helper functions for interacting with libcurl


Getting Started
===============

Please follow the donau manual you can view after
installing using

$ info taler-donau

or by visiting https://docs.taler.net/.