diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/handbook/chapters/installation.texi | 114 | ||||
-rw-r--r-- | doc/handbook/gnunet.texi | 2 |
2 files changed, 100 insertions, 16 deletions
diff --git a/doc/handbook/chapters/installation.texi b/doc/handbook/chapters/installation.texi index 326d49951..f00207091 100644 --- a/doc/handbook/chapters/installation.texi +++ b/doc/handbook/chapters/installation.texi | |||
@@ -9,12 +9,12 @@ package manager. | |||
9 | For understanding this guide properly it is important to know that | 9 | For understanding this guide properly it is important to know that |
10 | there are two different ways of running GNUnet: | 10 | there are two different ways of running GNUnet: |
11 | 11 | ||
12 | * Running the @emph{user services only} | 12 | * the @emph{single-user setup} |
13 | * Running both @emph{user and system services} | 13 | * the @emph{multi-user setup} |
14 | 14 | ||
15 | The latter variant has a better security model and requires extra preparation | 15 | The latter variant has a better security model and requires extra preparation |
16 | before running @code{make install} and a different configuration. Beginners who want to | 16 | before running @code{make install} and a different configuration. Beginners who want to |
17 | quickly try out GNUnet can use the @emph{user services only} variant. | 17 | quickly try out GNUnet can use the @emph{single-user setup}. |
18 | 18 | ||
19 | @menu | 19 | @menu |
20 | * Installing dependencies:: | 20 | * Installing dependencies:: |
@@ -139,13 +139,17 @@ in the home directory at @code{~/gnunet}. | |||
139 | @node Create user and groups for the system services | 139 | @node Create user and groups for the system services |
140 | @section Create user and groups for the system services | 140 | @section Create user and groups for the system services |
141 | 141 | ||
142 | @cartouche{If only user services shall be used this section can be skipped}. | 142 | @cartouche |
143 | For the single-user setup this section can be skipped. | ||
144 | @end cartouche | ||
143 | 145 | ||
144 | For using both user and system services, a dedicated user called @code{gnunet} | 146 | The multi-user setup means that there are @emph{system services}, which are |
145 | is needed. The system services will run as that user and the user services | 147 | run once per machine as a dedicated system user (called @code{gnunet}) and |
146 | will communicate with them over unix domain sockets. That's why the user | 148 | @emph{user services} which can be started by every user who wants to use |
147 | running GNUnet applications will need to be in the @code{gnunet} group. | 149 | GNUnet applications. The user services communicate with the system services |
148 | In addition the group @code{gnunetdns} may be needed (see below). | 150 | over unix domain sockets. To gain permissions to read and write those sockets |
151 | the users running GNUnet applications will need to be in the @code{gnunet} | ||
152 | group. In addition the group @code{gnunetdns} may be needed (see below). | ||
149 | 153 | ||
150 | Create user @code{gnunet} who is member of the group @code{gnunet} | 154 | Create user @code{gnunet} who is member of the group @code{gnunet} |
151 | (automatically created) and specify a home directory where the GNUnet | 155 | (automatically created) and specify a home directory where the GNUnet |
@@ -225,9 +229,11 @@ $ sudo make install | |||
225 | 229 | ||
226 | @node Extra Installation step: NSS plugin | 230 | @node Extra Installation step: NSS plugin |
227 | 231 | ||
228 | @cartouche{The installation of the NSS plugin can be skipped if GNS | 232 | @cartouche |
229 | resolution shall be used with legacy applications (that only | 233 | The installation of the NSS plugin can be skipped if GNS |
230 | support DNS).} | 234 | resolution shall be used with legacy applications (that only |
235 | support DNS). | ||
236 | @end cartouche | ||
231 | 237 | ||
232 | One important library is the GNS plugin for NSS (the name services | 238 | One important library is the GNS plugin for NSS (the name services |
233 | switch) which allows using GNS (the GNU name system) in the normal DNS | 239 | switch) which allows using GNS (the GNU name system) in the normal DNS |
@@ -269,8 +275,10 @@ hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4 | |||
269 | @node Extra installation step: installing the GNS Certificate Authority | 275 | @node Extra installation step: installing the GNS Certificate Authority |
270 | @subsection Extra installation step: installing the GNS Certificate Authority | 276 | @subsection Extra installation step: installing the GNS Certificate Authority |
271 | 277 | ||
272 | @cartouche{Installing the GNS certificate authority is only necessary if GNS shall | 278 | @cartouche |
273 | be used in a browser.} | 279 | Installing the GNS certificate authority is only necessary if GNS shall |
280 | be used in a browser. | ||
281 | @end cartouche | ||
274 | 282 | ||
275 | The GNS Certificate authority can provide TLS certificates for GNS names while | 283 | The GNS Certificate authority can provide TLS certificates for GNS names while |
276 | downloading webpages from legacy webservers. This allows browsers to use HTTPS | 284 | downloading webpages from legacy webservers. This allows browsers to use HTTPS |
@@ -296,7 +304,31 @@ Now GNS should work in browsers that are configured to use a SOCKS proxy on | |||
296 | 304 | ||
297 | @node Minimal configuration | 305 | @node Minimal configuration |
298 | @section Minimal configuration | 306 | @section Minimal configuration |
299 | TBD | 307 | GNUnet needs a configuration file to start. For the @emph{single-user setup} |
308 | an empty file is sufficient: | ||
309 | |||
310 | @example | ||
311 | $ touch ~/.config/gnunet.conf | ||
312 | @end example | ||
313 | |||
314 | For the @emph{multi-user setup} we need an extra config file for the system | ||
315 | services. The default location is @code{/etc/gnunet.conf}. The minimal | ||
316 | content of that file which activates the system services roll is: | ||
317 | |||
318 | @example | ||
319 | [arm] | ||
320 | START_SYSTEM_SERVICES = YES | ||
321 | START_USER_SERVICES = NO | ||
322 | @end example | ||
323 | |||
324 | The config file for the user services (@code{~/.config/gnunet.conf}) needs | ||
325 | the opposite configuration to activate the user services roll: | ||
326 | |||
327 | @example | ||
328 | [arm] | ||
329 | START_SYSTEM_SERVICES = NO | ||
330 | START_USER_SERVICES = YES | ||
331 | @end example | ||
300 | 332 | ||
301 | 333 | ||
302 | @node Checking the Installation | 334 | @node Checking the Installation |
@@ -313,14 +345,66 @@ as part of this handbook!. | |||
313 | 345 | ||
314 | 346 | ||
315 | @menu | 347 | @menu |
348 | * Starting GNUnet:: | ||
316 | * gnunet-gtk:: | 349 | * gnunet-gtk:: |
317 | * Statistics:: | 350 | * Statistics:: |
318 | * Peer Information:: | 351 | * Peer Information:: |
319 | @end menu | 352 | @end menu |
320 | 353 | ||
354 | @cindex Starting GNUnet | ||
321 | @cindex GNUnet GTK | 355 | @cindex GNUnet GTK |
322 | @cindex GTK | 356 | @cindex GTK |
323 | @cindex GTK user interface | 357 | @cindex GTK user interface |
358 | |||
359 | @node Starting GNUnet | ||
360 | @subsection Starting GNUnet | ||
361 | The GNUnet services are started and stopped by the ARM service (Automatic | ||
362 | Restart Manager). For the @emph{single-user setup} a simple | ||
363 | |||
364 | @example | ||
365 | $ gnunet-arm -s | ||
366 | @end example | ||
367 | |||
368 | starts a default set of services. Later GNUnet applications can request more | ||
369 | services to start without additional user interaction. GNUnet can be stopped | ||
370 | again using the @code{gnunet-arm}'s @code{-e} option. | ||
371 | |||
372 | The list of running services can be displayed using the @code{-I} option. | ||
373 | It should look similar to this example: | ||
374 | |||
375 | @example | ||
376 | $ gnunet-arm -I | ||
377 | Running services: | ||
378 | topology (gnunet-daemon-topology) | ||
379 | nat (gnunet-service-nat) | ||
380 | vpn (gnunet-service-vpn) | ||
381 | gns (gnunet-service-gns) | ||
382 | cadet (gnunet-service-cadet) | ||
383 | namecache (gnunet-service-namecache) | ||
384 | hostlist (gnunet-daemon-hostlist) | ||
385 | revocation (gnunet-service-revocation) | ||
386 | ats (gnunet-service-ats) | ||
387 | peerinfo (gnunet-service-peerinfo) | ||
388 | zonemaster (gnunet-service-zonemaster) | ||
389 | zonemaster-monitor (gnunet-service-zonemaster-monitor) | ||
390 | dht (gnunet-service-dht) | ||
391 | namestore (gnunet-service-namestore) | ||
392 | set (gnunet-service-set) | ||
393 | statistics (gnunet-service-statistics) | ||
394 | nse (gnunet-service-nse) | ||
395 | fs (gnunet-service-fs) | ||
396 | peerstore (gnunet-service-peerstore) | ||
397 | core (gnunet-service-core) | ||
398 | rest (gnunet-rest-server) | ||
399 | transport (gnunet-service-transport) | ||
400 | datastore (gnunet-service-datastore) | ||
401 | @end example | ||
402 | |||
403 | For the @emph{multi-user setup} first the system services need to be started | ||
404 | as the system user, i.e. the user @code{gnunet} needs to execute | ||
405 | @code{gnunet-arm -s}. This should be done by the system's init system. | ||
406 | |||
407 | |||
324 | @node gnunet-gtk | 408 | @node gnunet-gtk |
325 | @subsection gnunet-gtk | 409 | @subsection gnunet-gtk |
326 | 410 | ||
diff --git a/doc/handbook/gnunet.texi b/doc/handbook/gnunet.texi index 75a9f1f2b..5ff33d94c 100644 --- a/doc/handbook/gnunet.texi +++ b/doc/handbook/gnunet.texi | |||
@@ -119,7 +119,7 @@ Key Concepts | |||
119 | Installing GNUnet | 119 | Installing GNUnet |
120 | * Installing dependencies:: | 120 | * Installing dependencies:: |
121 | * Getting the Source Code:: | 121 | * Getting the Source Code:: |
122 | * Create @code{gnunet} user and group:: | 122 | * Create user and groups for the system services:: |
123 | * Preparing and Compiling the Source Code:: | 123 | * Preparing and Compiling the Source Code:: |
124 | * Installation:: | 124 | * Installation:: |
125 | * Checking the Installation:: | 125 | * Checking the Installation:: |