aboutsummaryrefslogtreecommitdiff
path: root/doc/handbook/chapters/preface.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/handbook/chapters/preface.texi')
-rw-r--r--doc/handbook/chapters/preface.texi117
1 files changed, 75 insertions, 42 deletions
diff --git a/doc/handbook/chapters/preface.texi b/doc/handbook/chapters/preface.texi
index 386cefa6d..636458eeb 100644
--- a/doc/handbook/chapters/preface.texi
+++ b/doc/handbook/chapters/preface.texi
@@ -1,13 +1,17 @@
1@node Preface 1@node Preface
2@chapter Preface 2@chapter Preface
3 3
4This collection of manuals describes how to use GNUnet, a framework 4@c FIXME: Do we have to mention that this is Free Software?
5@c FIXME: where did 'Free Software' in this sentence fit before
6@c FIXME: we changed it?
7This collection of manuals describes GNUnet, a framework
5for secure peer-to-peer networking with the high-level goal to provide 8for secure peer-to-peer networking with the high-level goal to provide
6a strong foundation Free Software for a global, distributed network 9a strong foundation for a global, distributed network
7that provides security and privacy. GNUnet in that sense aims to 10that provides security and privacy.
8replace the current Internet protocol stack. Along with an 11GNUnet in that sense aims to replace the current Internet protocol stack.
9application for secure publication of files, it has grown to include 12Along with an application for secure publication of files, it has grown to
10all kinds of basic applications for the foundation of a new Internet. 13include all kinds of basic applications for the foundation of a new
14Internet.
11 15
12@menu 16@menu
13* About this book:: 17* About this book::
@@ -22,47 +26,74 @@ all kinds of basic applications for the foundation of a new Internet.
22 26
23The books (described as ``book'' or ``books'' in the following) 27The books (described as ``book'' or ``books'' in the following)
24bundled as the ``GNUnet Reference Manual'' are based on the historic 28bundled as the ``GNUnet Reference Manual'' are based on the historic
25work of all contributors to GNUnet's documentation. It is our hope 29work of all contributors to previous documentation of GNUnet.
30It is our hope
26that the content is described in a way that does not require any 31that the content is described in a way that does not require any
27academic background, although some concepts will require further 32academic background, although some concepts will require further
28reading. 33reading.
29 34
30Our (long-term) goal with these books is to keep them self-contained. If 35Our (long-term) goal with these books is to keep them
31you see references to Wikipedia and other external sources (except for 36self-contained. If you see references to Wikipedia and other external
32our academic papers) it means that we are working on a solution to 37sources (except for our academic papers) it means that we are working
33describe the explanations found there which fits our use-case and licensing. 38on a solution to describe the explanations found there which fits our
34 39use-case and licensing.
35The first chapter (``Preface'') as well as the the second 40
36chapter (``Philosophy'') give an introduction to GNUnet as a project, 41Previously the documentation was contained in Drupal books, on the
37what GNUnet tries to achieve. 42old website. This format was considered unmaintainable for the future, so
43Texinfo was chosen. You might find old and very old sections in
44here in addition to more recent content. It took a long time to
45finish the move to Texinfo (from Drupal to LaTeX to wrong Texinfo
46output dump to good Texinfo) and only recently (late 2018, early
472019) content checking started. We apologize to the reader for
48any inconvenience and hope you apply logic where bad advice from
4910 years ago can be found (pipe to sudo to install software is
50one example). Patches (contributions) to this documentation are more
51than welcome!
52
53The first chapter (``Preface'') as well as the the second chapter
54(``Philosophy'') give an introduction to GNUnet as a project, what
55GNUnet tries to achieve. ``Key Concepts'' explains the key concepts
56in GNUnet.
57These three chapters are the most complete in the documentation.
58They are followed by chapters which explain specific parts of
59GNUnet (and need more work):
60``Installing GNUnet'', ``GNUnet Contributors Handbook'' and
61``GNUnet Developer Handbook''.
38 62
39@node Contributing to this book 63@node Contributing to this book
40@section Contributing to this book 64@section Contributing to this book
41 65
66@c FIXME: There's a good amount of repetition here, we should
67@c FIXME: fix this.
42The GNUnet Reference Manual is a collective work produced by various 68The GNUnet Reference Manual is a collective work produced by various
43people throughout the years. The version you are reading is derived 69people throughout the years.
44from many individual efforts hosted on our website. This was a failed 70
45experiment, and with the conversion to Texinfo we hope to address this 71The version you are reading is derived
46in the longterm. Texinfo is the documentation language of the GNU project. 72from many individual efforts hosted on one of our old websites.
73In the end it was considered to be impractical to read by
74those who required the information.
75With the conversion to Texinfo --- the version you are reading
76right now --- we hope to address this in the longterm.
77Texinfo is the documentation language of the GNU project.
78
47While it can be intimidating at first and look scary or complicated, 79While it can be intimidating at first and look scary or complicated,
48it is just another way to express text format instructions. We encourage 80it is just another way to express text format instructions.
49you to take this opportunity and learn about Texinfo, learn about GNUnet, 81
50and one word at a time we will arrive at a book which explains GNUnet in 82We encourage you to take this opportunity and learn about Texinfo,
51the least complicated way to you. Even when you don't want or can't learn 83learn about GNUnet, and one word at a time we will arrive at a
52Texinfo, you can contribute. Send us an Email or join our IRC chat room 84book which explains GNUnet in the least complicated way to you.
53on freenode and talk with us about the documentation (the prefered way 85
54to reach out is the mailinglist, since you can communicate with us 86Even when you don't want to or can't learn Texinfo, you can contribute.
55without waiting on someone in the chatroom). One way or another you 87Send us an Email or join our IRC chat room on freenode and talk with
56can help shape the understanding of GNUnet without the ability to read 88us about the documentation (the prefered way to reach out is the
57and understand its sourcecode. 89mailinglist, since you can communicate with us without waiting on
90someone in the chatroom).
91One way or another you can help shape the understanding of GNUnet
92without the ability to read and understand its sourcecode.
58 93
59@node Introduction 94@node Introduction
60@section Introduction 95@section Introduction
61 96
62@c In less than 2 printed pages describe the history of GNUnet here,
63@c what we have now and what's still missing (could be split into
64@c subchapters).
65
66GNUnet in its current version is the result of almost 20 years of work 97GNUnet in its current version is the result of almost 20 years of work
67from many contributors. So far, most contributions were made by 98from many contributors. So far, most contributions were made by
68volunteers or people paid to do fundamental research. At this stage, 99volunteers or people paid to do fundamental research. At this stage,
@@ -109,12 +140,17 @@ social network, resulting in a significant growth of the core team.
109In 2013, we launched @uref{https://taler.net, GNU Taler} to address 140In 2013, we launched @uref{https://taler.net, GNU Taler} to address
110the challenge of convenient 141the challenge of convenient
111and privacy-preserving online payments. In 2015, the 142and privacy-preserving online payments. In 2015, the
112@c TODO: Maybe even markup for the E if it renders in most outputs. 143@c XXX: It is not correct to refer to pEp as pEp stylistic,
113@uref{https://pep.foundation/, pEp} (pretty Easy privacy) project 144@c XXX: but the correct version would lead to problems with
145@c XXX: some of our outputs and/or older versions of texinfo
146@c XXX: and devices that display versions on consoles etc.
147@c XXX: This is why we keep the pEp until proven that p(tripple bar)p
148@c XXX: does not create broken outputs.
149@uref{https://pep.foundation/, pretty Easy privacy} (pEp) project
114announced that they will use GNUnet as the technology for their 150announced that they will use GNUnet as the technology for their
115meta-data protection layer, ultimately resulting in GNUnet e.V. 151meta-data protection layer, ultimately resulting in GNUnet e.V.
116entering into a formal long-term collaboration with the pEp 152entering into a formal long-term collaboration with the pEp
117foundation. In 2016, Taler Systems SA, a first startup using GNUnet 153Foundation. In 2016, Taler Systems SA, a first startup using GNUnet
118technology, was founded with support from the community. 154technology, was founded with support from the community.
119 155
120GNUnet is not merely a technical project, but also a political 156GNUnet is not merely a technical project, but also a political
@@ -131,7 +167,7 @@ Similarly its flaws are not limited to the protocol design. Thus,
131technical excellence by itself will not suffice to create a better 167technical excellence by itself will not suffice to create a better
132network. We also need to build a community that is wise, humble and 168network. We also need to build a community that is wise, humble and
133has a sense of humor to achieve our goal to create a technical 169has a sense of humor to achieve our goal to create a technical
134foundation for a society we would like to live in. 170foundation for a society we would like to live in.
135 171
136 172
137@node Project governance 173@node Project governance
@@ -142,15 +178,12 @@ follows the governance model of a benevolent dictator. This means
142that ultimately, the GNU project appoints the GNU maintainer and can 178that ultimately, the GNU project appoints the GNU maintainer and can
143overrule decisions made by the GNUnet maintainer. Similarly, the 179overrule decisions made by the GNUnet maintainer. Similarly, the
144GNUnet maintainer can overrule any decisions made by individual 180GNUnet maintainer can overrule any decisions made by individual
145@c TODO: Should we mention if this is just about GNUnet? Other projects
146@c TODO: in GNU seem to have rare issues (GCC, the 2018 documentation
147@c TODO: discussion.
148developers. Still, in practice neither has happened in the last 20 181developers. Still, in practice neither has happened in the last 20
149years, and we hope to keep it that way. 182years for GNUnet, and we hope to keep it that way.
150 183
151@c TODO: Actually we are a Swiss association, or just a German association 184@c TODO: Actually we are a Swiss association, or just a German association
152@c TODO: with Swiss bylaws/Satzung? 185@c TODO: with Swiss bylaws/Satzung?
153@c TODO: Rewrite one of the 'GNUnet eV may also' sentences. 186@c TODO: Rewrite one of the 'GNUnet eV may also' sentences?
154The GNUnet project is supported by GNUnet e.V., a German association 187The GNUnet project is supported by GNUnet e.V., a German association
155where any developer can become a member. GNUnet e.V. serves as a 188where any developer can become a member. GNUnet e.V. serves as a
156legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also 189legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also