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
|
.TH GNUNET.CONF "5" "12 Aug 2013" "GNUnet"
.SH NAME
gnunet.conf \- GNUnet configuration file
.SH SYNOPSIS
~/.config/gnunet.conf
.SH DESCRIPTION
.PP
A GNUnet setup typically consists of 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 GNUnet GTK package) can be used to edit this
configuration. The parts of GNUnet that are run 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.
.TP
The 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.
.PP
Default 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.
.SH General OPTIONS
.PP
Many 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.
.PP
The following options are generic and shared by all services:
.IP HOSTNAME
The hostname specifies the machine on which the service is running.
This is usually "localhost".
.IP BINARY
The filename that implements the service. For example "gnunet-service-ats".
.IP FORCESTART
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.
.IP AUTOSTART
Set to YES to automatically start the service when it is requested by
another service. YES for most GNUnet services.
.IP NOARMBIND
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.
.IP PREFIX
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.
.IP ACCEPT_FROM
A semi-column separated list of IPv4 addresses that are allowed to use
the service; usually 127.0.0.1.
.IP ACCEPT_FROM6
A semi-column separated list of IPv6 addresses that are allowed to use the
service; usually ::1.
.IP UNIXPATH
Path to use for the UNIX domain socket for inter process communication with
the service on POSIX systems.
.IP UNIX_MATCH_UID
If UNIX domain sockets are used, set this to YES if only users with the same
UID are allowed to access the service.
.IP UNIX_MATCH_GID
If UNIX domain sockets are used, set this to YES if only users with the same
GID are allowed to access the service.
.IP USER_SERVICE
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.
.B
.SH ATS Options
.IP UNSPECIFIED_QUOTA_IN
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP UNSPECIFIED_QUOTA_OUT
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP LOOPBACK_QUOTA_IN
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP LOOPBACK_QUOTA_OUT
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP LAN_QUOTA_IN
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP LAN_QUOTA_OUT
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP WAN_QUOTA_IN
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP WAN_QUOTA_OUT
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP WLAN_QUOTA_IN
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.IP WLAN_QUOTA_OUT
quotes in KiB or MiB per seconds. Or use the word "unlimited"
.SH EXAMPLES
This 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 firewall on
IPv4, as such NAT is enabled. Please rememeber to change your IP address
to the actual external address for your usage.
.PP
[hostlist]
OPTIONS = \-b
SERVERS = http://v9.gnunet.org:58080/
[nat]
BEHIND_NAT = YES
ENABLE_UPNP = YES
DISABLEV6 = YES
EXTERNAL_ADDRESS = 157.166.249.10
[arm]
SYSTEM_ONLY = YES
USER_ONLY = NO
.SH FILES
.TP
~/.config/gnunet.conf
GNUnet configuration file
.SH "REPORTING BUGS"
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic
mail to <bug-gnunet@gnu.org>
.SH "SEE ALSO"
\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1)
|
