doc/man/gnunet.conf.5

   1 .TH GNUNET.CONF "5" "12 Aug 2013" "GNUnet"
   2 .SH NAME
   3 gnunet.conf \- GNUnet configuration file
   4 .SH SYNOPSIS
   5 ~/.gnunet/gnunet.conf
   6 .SH DESCRIPTION
   7 .PP
   8
   9 A 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/.gnunet/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/.gnunet/gnunet.conf". The latter config file can skip any options for the services.
  10
  11 .TP
  12 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.
  13 .PP
  14 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.
  15
  16 .SH General OPTIONS
  17 .PP
  18 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 "SERVICEHOME".  Then, in all filenames that begin with "$SERVICEHOME" the "$SERVICEHOME" will be replaced with the respective value at runtime.  The main use of this is to redefine "$SERVICEHOME", which by default points to "$HOME/.gnunet/".  By setting this variable, you can change the location where GNUnet stores its internal data.
  19 .PP
  20
  21 The following options are generic and shared by all services:
  22
  23 .IP HOSTNAME
  24     The hostname specifies the machine on which the service is running.  This is usually "localhost".
  25 .IP HOME
  26     Which home directory should be used for the service.  Usually "$SERVICEHOME".
  27 .IP BINARY
  28     The filename that implements the service. For example "gnunet-service-ats".
  29 .IP AUTOSTART
  30     This defines the section it is defined in, which should be a service, will be started by the ARM service if the value is set to YES.
  31 .IP ACCEPT_FROM
  32     A semi-column separated list of IPv4 addresses that are allowed to use the service; usually 127.0.0.1.
  33 .IP ACCEPT_FROM6
  34     A semi-column separated list of IPv6 addresses that are allowed to use the service; usually ::1.
  35 .IP UNIXPATH
  36     Path to use for the UNIX domain socket for inter process communication with the service on POSIX systems.
  37 .IP UNIX_MATCH_UID
  38     If UNIX domain sockets are used, set this to YES if only users with the same UID are allowed to access the service.
  39 .IP UNIX_MATCH_GID
  40     If UNIX domain sockets are used, set this to YES if only users with the same GID are allowed to access the service.
  41
  42 .SH ARM Options
  43
  44 This section is configuration for the automatic restart manager which is responsible for launching services.
  45
  46 .IP DEFAULTSERVICES
  47     list of services that ARM should always start by default.  AUTOSTART services are only started when the service is needed by some other service.  The services listed here will always be started, not just on-demand.  "topology" and "hostlist" should virtually always be listed here, and most users will want to specify high-level applications like "fs", "gns" or "pt" here as well.
  48 .B
  49 .SH ATS Options
  50
  51 .IP UNSPECIFIED_QUOTA_IN
  52     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  53 .IP UNSPECIFIED_QUOTA_OUT
  54     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  55 .IP LOOPBACK_QUOTA_IN
  56     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  57 .IP LOOPBACK_QUOTA_OUT
  58     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  59 .IP LAN_QUOTA_IN
  60     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  61 .IP LAN_QUOTA_OUT
  62     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  63 .IP WAN_QUOTA_IN
  64     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  65 .IP WAN_QUOTA_OUT
  66     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  67 .IP WLAN_QUOTA_IN
  68     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  69 .IP WLAN_QUOTA_OUT
  70     quotes in KiB or MiB per seconds.  Or use the word "unlimited"
  71
  72 .SH EXAMPLES
  73
  74 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 firewal on IPv4, as such NAT is enabled.  Please rememeber to change your IP address to the actual external address for your usage.
  75 .PP
  76     [hostlist]
  77     OPTIONS = -b
  78     SERVERS = http://v9.gnunet.org:58080/
  79
  80     [arm]
  81     DEFAULTSERVICES = topology hostlist fs
  82
  83     [nat]
  84     BEHIND_NAT = YES
  85     ENABLE_UPNP = YES
  86     DISABLEV6 = YES
  87     EXTERNAL_ADDRESS = 157.166.249.10
  88
  89 .SH FILES
  90 .TP
  91 ~/.gnunet/gnunet.conf
  92 GNUnet configuration file
  93 .SH "REPORTING BUGS"
  94 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug-gnunet@gnu.org>
  95 .SH "SEE ALSO"
  96 \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1)