aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet.conf.5')
-rw-r--r--doc/man/gnunet.conf.598
1 files changed, 75 insertions, 23 deletions
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5
index 3df3b437a..3dd8c7b62 100644
--- a/doc/man/gnunet.conf.5
+++ b/doc/man/gnunet.conf.5
@@ -1,4 +1,4 @@
1.TH GNUNET.CONF "5" "12 Aug 2013" "GNUnet" 1.TH GNUNET.CONF "5" "05 May 2018" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet.conf \- GNUnet configuration file 3gnunet.conf \- GNUnet configuration file
4.SH SYNOPSIS 4.SH SYNOPSIS
@@ -6,44 +6,92 @@ gnunet.conf \- GNUnet configuration file
6.SH DESCRIPTION 6.SH DESCRIPTION
7.PP 7.PP
8 8
9A GNUnet setup typically consists of a a set of service processes run by a user "gnunet" and a set of user-interface processes run by a standard account. The default location for the configuration file for the services is "~gnunet/.config/gnunet.conf"; however, as normal users also may need read-access to this configuration, you might want to instead put the service process configuration in "/etc/gnunet.conf". gnunet\-setup (part of the GTK package) can be used to edit this configuration. The parts of GNUnet that is ran as a normal user may have config options too and they read from "$HOME/.config/gnunet.conf". The latter config file can skip any options for the services. 9A GNUnet setup typically consists of a set of service processes run by a user
10"gnunet" and a set of user-interface processes run by a standard account.
11The default location for the configuration file for the services is
12"~gnunet/.config/gnunet.conf"; however, as normal users also may need
13read-access to this configuration, you might want to instead put the service
14process configuration in "/etc/gnunet.conf".
15gnunet\-setup (part of the GNUnet GTK package) can be used to edit this
16configuration. The parts of GNUnet that are run as a normal user may have
17config options too and they read from "$HOME/.config/gnunet.conf".
18The latter config file can skip any options for the services.
10 19
11.TP 20.TP
12The basic structure of the configuration file is the following. The file is split into sections. Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE". Empty lines and lines beginning with a "#" are treated as comments. Almost all options are optional and the tools resort to reasonable defaults if they are not present. 21The basic structure of the configuration file is the following. The file is
22split into sections. Every section begins with "[SECTIONNAME]" and contains
23a number of options of the form "OPTION=VALUE".
24Empty lines and lines beginning with a "#" are treated as comments.
25Almost all options are optional and the tools resort to reasonable defaults
26if they are not present.
13.PP 27.PP
14Default values for all of the options can be found in the files in the "$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will work out of the box with those. See the examples section below for some common setups on top of that. 28Default values for all of the options can be found in the files in the
29"$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will
30work out of the box with those. See the examples section below for
31some common setups on top of that.
15 32
16.SH General OPTIONS 33.SH General OPTIONS
17.PP 34.PP
18Many options will be common between sections. They can be repeated under each section with different values. The "[PATHS]" section is special. Here, it is possible to specify values for variables like "GNUNET_HOME". Then, in all filenames that begin with "$GNUNET_HOME" the "$GNUNET_HOME" will be replaced with the respective value at runtime. The main use of this is to redefine "$GNUNET_HOME", which by default points to "$HOME/.config/". By setting this variable, you can change the location where GNUnet stores its internal data. 35Many options will be common between sections. They can be repeated under
36each section with different values. The "[PATHS]" section is special.
37Here, it is possible to specify values for variables like "GNUNET_HOME".
38Then, in all filenames that begin with "$GNUNET_HOME" the "$GNUNET_HOME"
39will be replaced with the respective value at runtime. The main use of
40this is to redefine "$GNUNET_HOME", which by default points to "$HOME/.config/".
41By setting this variable, you can change the location where GNUnet stores
42its internal data.
43gnunet.conf accepts the variable "GNUNET_TMP" which we suggest to use in
44place of the absolute definition of "/tmp".
45So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo".
46 The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or
47 "$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo".
48
19.PP 49.PP
20 50
21The following options are generic and shared by all services: 51The following options are generic and shared by all services:
22 52
23.IP HOSTNAME 53.IP HOSTNAME
24 The hostname specifies the machine on which the service is running. This is usually "localhost". 54 The hostname specifies the machine on which the service is running.
55 This is usually "localhost".
25.IP BINARY 56.IP BINARY
26 The filename that implements the service. For example "gnunet-service-ats". 57 The filename that implements the service. For example "gnunet-service-ats".
27.IP FORCESTART 58.IP IMMEDIATE_START
28 Start the service always when the peer starts. Set to YES for services that should always be launched, even if no other service explicitly needs them. 59 Start the service always when the peer starts. Set to YES for services
29.IP AUTOSTART 60 that should always be launched, even if no other service explicitly needs
30 Set to YES to automatically start the service when it is requested by another service. YES for most GNUnet services. 61 them.
62.IP START_ON_DEMAND
63 Set to YES to automatically start the service when it is requested by
64 another service. YES for most GNUnet services.
31.IP NOARMBIND 65.IP NOARMBIND
32 Set to YES to never have ARM bind to the respective socket. This option is mostly for debugging in situations where ARM cannot pass the pre-bound socket to the child due to interference from PREFIX-commands. This option is only effective in combination with FORCESTART being YES. NO by default. 66 Set to YES to never have ARM bind to the respective socket. This option is
67 mostly for debugging in situations where ARM cannot pass the pre-bound
68 socket to the child due to interference from PREFIX-commands.
69 This option is only effective in combination with IMMEDIATE_START being YES.
70 NO by default.
33.IP PREFIX 71.IP PREFIX
34 PREFIX the given command (with its arguments) to the actual BINARY to be executed. Useful to run certain services under special supervisors (like strace or valgrind). Typically used in combination with FORCESTART and NOARMBIND. Empty by default. 72 PREFIX the given command (with its arguments) to the actual BINARY to be
73 executed. Useful to run certain services under special supervisors (like
74 strace or valgrind). Typically used in combination with IMMEDIATE_START
75 and NOARMBIND. Empty by default.
35.IP ACCEPT_FROM 76.IP ACCEPT_FROM
36 A semi-column separated list of IPv4 addresses that are allowed to use the service; usually 127.0.0.1. 77 A semi-column separated list of IPv4 addresses that are allowed to use
78 the service; usually 127.0.0.1.
37.IP ACCEPT_FROM6 79.IP ACCEPT_FROM6
38 A semi-column separated list of IPv6 addresses that are allowed to use the service; usually ::1. 80 A semi-column separated list of IPv6 addresses that are allowed to use the
81 service; usually ::1.
39.IP UNIXPATH 82.IP UNIXPATH
40 Path to use for the UNIX domain socket for inter process communication with the service on POSIX systems. 83 Path to use for the UNIX domain socket for inter process communication with
84 the service on POSIX systems.
41.IP UNIX_MATCH_UID 85.IP UNIX_MATCH_UID
42 If UNIX domain sockets are used, set this to YES if only users with the same UID are allowed to access the service. 86 If UNIX domain sockets are used, set this to YES if only users with the same
87 UID are allowed to access the service.
43.IP UNIX_MATCH_GID 88.IP UNIX_MATCH_GID
44 If UNIX domain sockets are used, set this to YES if only users with the same GID are allowed to access the service. 89 If UNIX domain sockets are used, set this to YES if only users with the same
45.IP USER_SERVICE 90 GID are allowed to access the service.
46 Set to YES if this service should be run per-user, NO if this is a system service. End-users should never have to change the defaults GNUnet provides for this option. 91.IP RUN_PER_USER
92 Set to YES if this service should be run per-user, NO if this is a system
93 service. End-users should never have to change the defaults GNUnet provides
94 for this option.
47 95
48 96
49 97
@@ -73,7 +121,10 @@ The following options are generic and shared by all services:
73 121
74.SH EXAMPLES 122.SH EXAMPLES
75 123
76This example is a simple way to get started, using a server that has a known list of peers to get you started. Most users will be behind a firewal on IPv4, as such NAT is enabled. Please rememeber to change your IP address to the actual external address for your usage. 124This example is a simple way to get started, using a server that has a known
125list of peers to get you started. Most users will be behind a firewall on
126IPv4, as such NAT is enabled. Please rememeber to change your IP address
127to the actual external address for your usage.
77.PP 128.PP
78 [hostlist] 129 [hostlist]
79 OPTIONS = \-b 130 OPTIONS = \-b
@@ -86,14 +137,15 @@ This example is a simple way to get started, using a server that has a known lis
86 EXTERNAL_ADDRESS = 157.166.249.10 137 EXTERNAL_ADDRESS = 157.166.249.10
87 138
88 [arm] 139 [arm]
89 SYSTEM_ONLY = YES 140 START_SYSTEM_SERVICES = YES
90 USER_ONLY = NO 141 START_USER_SERVICES = NO
91 142
92.SH FILES 143.SH FILES
93.TP 144.TP
94~/.config/gnunet.conf 145~/.config/gnunet.conf
95GNUnet configuration file 146GNUnet configuration file
96.SH "REPORTING BUGS" 147.SH "REPORTING BUGS"
97Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org> 148Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic
149mail to <bug-gnunet@gnu.org>
98.SH "SEE ALSO" 150.SH "SEE ALSO"
99\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) 151\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1)