summaryrefslogtreecommitdiff
path: root/doc/handbook/gnunet.texi
blob: a622c8f491dfb9b1933a9b86c165eb2c1adabe65 (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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
\input texinfo
@c -*-texinfo-*-
@setfilename gnunet.info
@documentencoding UTF-8
@settitle GNUnet Reference Manual
@c @exampleindent 2

@c Set Versions which might be used in more than one place:
@set GNUFTP-URL https://ftp.gnu.org/gnu/gnunet
@set PYPI-URL https://pypi.python.org/packages/source
@set GNURL-VERSION-CURRENT 7.55.1
@set GNUNET-DIST-URL https://gnunet.org/sites/default/files/
@include version.texi
@c @set OPENPGP-SIGNING-KEY-ID

@copying
Copyright @copyright{} 2001-2019 GNUnet e.V.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
copy of the license is included in the section entitled ``GNU Free
Documentation License''.

A copy of the license is also available from the Free Software
Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.

Alternately, this document is also available under the General
Public License, version 3 or later, as published by the Free Software
Foundation.  A copy of the license is included in the section entitled
``GNU General Public License''.

A copy of the license is also available from the Free Software
Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
@end copying

@c TODO: Improve this and improve https://directory.fsf.org/wiki/Gnunet
@c NOTE FOR TRANSLATORS: Due to en.wikipedia.org being the wikipedia
@c                       which is more up to date than others, refrain
@c                       from using localized wikipedia unless you are
@c                       sure the articles content is good enough. For
@c                       example the german wikipedia entry for GNUnet
@c                       is in a terrible shape, but the en.wikipedia.org
@c                       entry is still acceptable (although in need of
@c                       updates).

@dircategory Networking
@direntry
* GNUnet: (gnunet).       Framework for secure peer-to-peer networking
@end direntry

@titlepage
@title GNUnet Reference Manual
@subtitle Installing, configuring, using and contributing to GNUnet
@author The GNUnet Developers

@page
@vskip 0pt plus 1filll
Edition @value{EDITION} @*

@insertcopying
@end titlepage

@summarycontents
@contents

@node Top
@top Introduction

This document is the Reference Manual for GNUnet version @value{VERSION}.

@menu

* Preface::                         Chapter 0
* Philosophy::                      About GNUnet
* Key Concepts::                    Key concepts of GNUnet
@c * Vocabulary::                      Vocabulary
* Installing GNUnet::		    Installing GNUnet
* Using GNUnet::                    Using GNUnet
@c * Configuration Handbook::          Configuring GNUnet
* GNUnet Contributors Handbook::    Contributing to GNUnet
* GNUnet Developer Handbook::       Developing GNUnet
* GNU Free Documentation License::  The license of this manual
* GNU General Public License::
* GNU Affero General Public License::
* Concept Index::                   Concepts
* Programming Index::               Data types, functions, and variables

@detailmenu
 --- The Detailed Node Listing ---

Preface

* About this book
* Contributing to this book
* Introduction
* Typography::

Philosophy

* Design Principles::
* Privacy and Anonymity::
* Practicality::

Key Concepts

* Authentication::
* Accounting to Encourage Resource Sharing::
* Confidentiality::
* Anonymity::
* Deniability::
* Peer Identities::
* Zones in the GNU Name System (GNS Zones)::
* Egos::
* Backup of Identities and Egos::
* Revocation::

Installing GNUnet
* Installing dependencies::
* Getting the Source Code::
* Create @code{gnunet} user and group::
* Preparing and Compiling the Source Code::
* Installation::
* Checking the Installation::
* The graphical configuration interface::
* Config Leftovers::

Using GNUnet

* Start and stop GNUnet::
* First steps - Using the GNU Name System::
* First steps - Using GNUnet Conversation::
* First steps - Using the GNUnet VPN::
* File-sharing::
* The GNU Name System::
* reclaimID Identity Provider::
* Using the Virtual Public Network::

GNUnet Contributors Handbook

* Contributing to GNUnet::
* Licenses of contributions::
* Copyright Assignment::
* Contributing to the Reference Manual::
* Contributing testcases::

GNUnet Developer Handbook

* Developer Introduction::
* Internal dependencies::
* Code overview::
* System Architecture::
* Subsystem stability::
* Naming conventions and coding style guide::
* Build-system::
* Developing extensions for GNUnet using the gnunet-ext template::
* Writing testcases::
* Building GNUnet and its dependencies::
* TESTING library::
* Performance regression analysis with Gauger::
* TESTBED Subsystem::
* libgnunetutil::
* Automatic Restart Manager (ARM)::
* TRANSPORT Subsystem::
* NAT library::
* Distance-Vector plugin::
* SMTP plugin::
* Bluetooth plugin::
* WLAN plugin::
* ATS Subsystem::
* CORE Subsystem::
* CADET Subsystem::
* NSE Subsystem::
* HOSTLIST Subsystem::
* IDENTITY Subsystem::
* NAMESTORE Subsystem::
* PEERINFO Subsystem::
* PEERSTORE Subsystem::
* SET Subsystem::
* STATISTICS Subsystem::
* Distributed Hash Table (DHT)::
* GNU Name System (GNS)::
* GNS Namecache::
* REVOCATION Subsystem::
* File-sharing (FS) Subsystem::
* REGEX Subsystem::

@end detailmenu
@end menu

@c *********************************************************************
@include chapters/preface.texi
@c *********************************************************************

@c *********************************************************************
@include chapters/philosophy.texi
@c *********************************************************************

@c *********************************************************************
@include chapters/keyconcepts.texi
@c *********************************************************************

@c *********************************************************************
@include chapters/installation.texi
@c *********************************************************************

@c *********************************************************************
@include chapters/user.texi
@c *********************************************************************

@include chapters/contributing.texi

@c *********************************************************************
@include chapters/developer.texi
@c *********************************************************************

@c *********************************************************************
@node GNU Free Documentation License
@appendix GNU Free Documentation License
@cindex license, GNU Free Documentation License
@include fdl-1.3.texi

@c *********************************************************************
@node GNU General Public License
@appendix GNU General Public License
@cindex license, GNU General Public License
@include gpl-3.0.texi

@c *********************************************************************
@node GNU Affero General Public License
@appendix GNU Affero General Public License
@cindex license, GNU Affero General Public License
@include agpl-3.0.texi

@c *********************************************************************
@node Concept Index
@unnumbered Concept Index
@printindex cp

@node Programming Index
@unnumbered Programming Index
@syncodeindex tp fn
@syncodeindex vr fn
@syncodeindex pg fn
@printindex fn

@bye