netsukuku/src/man/netsukuku.conf.5

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "netsukuku.conf 8"
.TH netsukuku.conf 8 "2006-06-14" "NetsukukuD 0.0.9b (debug)" ""
.SH "NAME"
netsukuku.conf \- Netsukuku daemon configuration file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
/etc/netsukuku/netsukuku.conf
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIntkd\fR\|(8) loads its options from the command line and from \fBnetsukuku.conf\fR.
The options that are changed infrequently resides in the configuration file.
The \fBnetsukuku.conf\fR file is typically installed at /etc/netsukuku/netsukuku.conf.
.PP
The comments starts with a '#'.
If an option is commented, \fBntkd\fR will use its default value.
.PP
The character '=' is used to assign a value to an option.
.PP
All the options will be overridden by their command line equivalent.
.SH "OPTIONS"
.IX Header "OPTIONS"
.Sh "\s-1RESTRICTED\s0 \s-1MODE\s0"
.IX Subsection "RESTRICTED MODE"
.IP "\fBntk_restricted_mode\fR = \fIbool\fR" 4
.IX Item "ntk_restricted_mode = bool"
When set to 1, \fBntkd\fR will be started in restricted mode to be compatible
with Internet. In the restricted mode, only IPs of the largest private subnet,
i.e. 10.x.x.x are chosen.
.Sp
Default: \fI0\fR
.IP "\fBntk_restricted_class\fR = \fIbool\fR" 4
.IX Item "ntk_restricted_class = bool"
When set to 1 the IPs will be chosen from the 172.16.0.0\-172.31.255.255 range
(use this option only if you can't use the 10.x.x.x class).
.Sp
Default: \fI0\fR
.Sh "\s-1INTERNET\s0 \s-1CONNECTION\s0"
.IX Subsection "INTERNET CONNECTION"
All these Internet options requires \fBntk_restricted_mode\fR set to 1.
.IP "\fBinternet_connection\fR = \fIbool\fR" 4
.IX Item "internet_connection = bool"
When set to 1, it specifies that this computer has an active Internet
connection. Note that \fBntkd\fR will overwrite any default route if this
option is set to 0 and the shared Internet connections of other nodes are
used.
.Sp
Default: \fI0\fR
.IP "\fBinternet_gateway\fR = \fIIP:interface\fR" 4
.IX Item "internet_gateway = IP:interface"
It specifies the default gateway used by \fIlocalhost\fR to reach the Internet.
This option is necessary only if you don't have the default route set when you
run \fBntkd\fR (i.e. you haven't connected yet).
If this option isn't specified, \fBntkd\fR will automatically retrieve the
default Internet gateway from the routing table.
Example: 
	internet_gateway = 192.168.1.1:eth0
.Sp
Default: \fI(null)\fR
.IP "\fBinternet_download_rate\fR = \fIKb\fR" 4
.IX Item "internet_download_rate = Kb"
This option is required if the \fBinternet_connection\fR option has been set to
1. It must be set to the download rate of the Internet connection in
KiloBytes. Example:
.Sp
.Vb 1
\&        internet_download_rate = 640
.Ve
.Sp
Default: \fI(null)\fR
.IP "\fBinternet_upload_rate\fR = \fIKb\fR" 4
.IX Item "internet_upload_rate = Kb"
This option is required if the \fBinternet_connection\fR option has been set to
1. It must be set to the upload rate of the Internet connection in
KiloBytes. Example:
.Sp
.Vb 1
\&        internet_upload_rate = 30
.Ve
.Sp
Default: \fI(null)\fR
.IP "\fBinternet_ping_hosts\fR = \fIhost1:host2:host3:...\fR" 4
.IX Item "internet_ping_hosts = host1:host2:host3:..."
Specifies a list of Internet hostnames which \fBntkd\fR will ping periodically to
verify the status of the Internet connection. If all the hosts specified
aren't reachable, it will assume that the Internet connection isn't available
anymore. When one them becoms pingable, \fBntkd\fR will enable again the
Internet Gateway Search. Example:
.Sp
.Vb 1
\&        internet_ping_hosts = google.com:cisco.com:sourceforge.net:dyne.org
.Ve
.Sp
This option hasn't a default value, it must be specified in the
\&\fBnetsukuku.conf\fR file.
.IP "\fBshare_internet\fR = \fIbool\fR" 4
.IX Item "share_internet = bool"
When set to 1, \fBntkd\fR shares the Internet connection among all the other
Netsukuku nodes.
.Sp
Default: \fI1\fR
.IP "\fBshape_internet\fR = \fIbool\fR" 4
.IX Item "shape_internet = bool"
Specifies if \fBntkd\fR will execute the \fI/etc/netsukuku/tc_shaper.sh\fR script to
activate the traffic shaping of the Internet connection.
.Sp
Default: \fI0\fR
.IP "\fBuse_shared_internet\fR = \fIbool\fR" 4
.IX Item "use_shared_internet = bool"
Specifies if \fBntkd\fR will load balance the Internet traffic of this host using
the Inet connections shared by the Netsukuku nodes.
When set to 0, localhost (this machine) uses only its local Internet
connection (if any).
.Sp
Default: \fI1\fR
.Sh "\s-1ANDNA\s0"
.IX Subsection "ANDNA"
.IP "\fBdisable_andna\fR = \fIbool\fR" 4
.IX Item "disable_andna = bool"
When set to 1, \fBntkd\fR won't load the \s-1\fIANDNA\s0\fR\|(8) daemon.
Note that when the \s-1ANDNA\s0 daemon is disabled, the andna system will not work at
all, so it will be impossible to resolve, register or update hostnames.
.Sp
Default: \fI0\fR
.IP "\fBdisable_resolvconf\fR = \fIbool\fR" 4
.IX Item "disable_resolvconf = bool"
When \fBntkd\fR starts it modifies \fI/etc/resolv.conf\fR writing in the first
line \*(L"nameserver 127.0.0.1\*(R". The old \fI/etc/resolv.conf\fR is copied in
\&\fI/etc/resolv.conf.bak\fR. When the daemon is closed \fI/etc/resolv.conf\fR is
restored. If you want to disable this set disable_resolvconf to 1.
If it is disabled you won't be able to resolve hostnames!
.Sp
Default: \fI0\fR
.Sh "\s-1LIMITS\s0"
.IX Subsection "LIMITS"
Note: in the current \fBntkd\fR version these limits aren't effective.
.IP "\fBntk_max_connections\fR = \fInumber\fR" 4
.IX Item "ntk_max_connections = number"
How many connection the netsukuku daemons can simultaneusly handle.
.Sp
Default: \fI512\fR
.IP "\fBntk_max_accepts_per_host\fR = \fInumber\fR" 4
.IX Item "ntk_max_accepts_per_host = number"
How many simultaneusly connections to the daemons from a single host are
allowed.
.Sp
Default: \fI16\fR
.IP "\fBmax_accepts_per_host_time\fR = \fIseconds\fR" 4
.IX Item "max_accepts_per_host_time = seconds"
The wait time necessary for a host to reconnect to the daemons after all the
ntk_max_accepts_per_host were used.
.Sp
Default: \fI4\fR
.Sh "\s-1FILES\s0"
.IX Subsection "FILES"
.IP "\fBpid_file\fR = \fIfilename\fR" 4
.IX Item "pid_file = filename"
\&\fBntkd\fR will save its process id in this file. 
It is used to check if other instances of ntkd are already running.
Only one instance is allowed.
.Sp
Default: \fI/var/run/ntkd.pid\fR
.IP "\fBntk_ext_map_file\fR = \fIfilename\fR" 4
.IX Item "ntk_ext_map_file = filename"
.PD 0
.IP "\fBntk_int_map_file\fR = \fIfilename\fR" 4
.IX Item "ntk_int_map_file = filename"
.IP "\fBntk_bnode_map_file\fR = \fIfilename\fR" 4
.IX Item "ntk_bnode_map_file = filename"
.PD
Specify the paths of the maps saved by the daemon.
.Sp
Default: \fI/usr/share/netsukuku/ext_map_file\fR
.Sp
Default: \fI/usr/share/netsukuku/int_map_file\fR
.Sp
Default: \fI/usr/share/netsukuku/bnode_map_file\fR
.IP "\fBandna_hnames_file\fR = \fIfilename\fR" 4
.IX Item "andna_hnames_file = filename"
Specify the path of the file which keeps the \s-1ANDNA\s0 hostnames of the local
host. These hostnames will be registerd in \s-1ANDNA\s0.
.Sp
Default: \fI/etc/netsukuku/andna_hostnames\fR
.IP "\fBsnsd_nodes_file\fR = \fIfilename\fR" 4
.IX Item "snsd_nodes_file = filename"
The snsd_nodes_file keeps the list of the \s-1SNSD\s0 records which will be register
in \s-1ANDNA\s0.
.Sp
Default: \fI/etc/netsukuku/snsd_nodes\fR
.IP "\fBandna_lclkey_file\fR = \fIfilename\fR" 4
.IX Item "andna_lclkey_file = filename"
Specifies the location of the \fIlocal keyring\fR file.
In this keyring the \s-1ANDNA\s0 public and secret keys are saved. Handle this file
with care: without it, you won't be able to update your hostnames, thus you'll
definitely lose them.
.Sp
Default: \fI/usr/share/netsukuku/andna_lcl_keyring\fR
.IP "\fBandna_cache_file\fR = \fIfilename\fR" 4
.IX Item "andna_cache_file = filename"
.PD 0
.IP "\fBandna_lcl_file\fR = \fIfilename\fR" 4
.IX Item "andna_lcl_file = filename"
.IP "\fBandna_rhc_file\fR = \fIfilename\fR" 4
.IX Item "andna_rhc_file = filename"
.IP "\fBandna_counter_c_file\fR = \fIfilename\fR" 4
.IX Item "andna_counter_c_file = filename"
.PD
Specify the paths of the caches used by the \s-1ANDNA\s0 daemon.
.Sp
Default: \fI/usr/share/netsukuku/andna_cache\fR
.Sp
Default: \fI/usr/share/netsukuku/andna_lcl_cache\fR
.Sp
Default: \fI/usr/share/netsukuku/andna_rh_cache\fR
.Sp
Default: \fI/usr/share/netsukuku/andna_counter_cache\fR
.IP "\fBip_masquerade_script\fR = \fIfilename\fR" 4
.IX Item "ip_masquerade_script = filename"
Specifies the path of the \s-1IP\s0 masquerading script.
This script is launched by NetsukukuD, at its start, when it shares the Internet
connection. The script will activate the \s-1IP\s0 masquerading.
The script is also used to disable the \s-1IP\s0 masquerading when \fBntkd\fR is closed.
.Sp
Default: \fI/etc/netsukuku/ip_masquerade.sh\fR
.IP "\fBtc_shaper_script\fR = \fIfilename\fR" 4
.IX Item "tc_shaper_script = filename"
Specifies the path of the traffic shaping script.
This script manages the traffic shaping for the upload bandwidth.
It is executed by \fBntkd\fR at its start if its relative option has been
enabled.
.Sp
Default: \fI/etc/netsukuku/tc_shaper.sh\fR
.SH "CONTACTS"
.IX Header "CONTACTS"
Subscribe to the netsukuku mailing to get help, be updated on the latest news
and discuss on its development.
.PP
To subscribe to the list, send a message to:
    netsukuku\-subscribe@lists.dyne.org
.PP
We live night and day in \s-1IRC\s0, come to see us in:
#netsukuku 
on the FreeNode irc server (irc.freenode.org).
.SH "AUTHORS"
.IX Header "AUTHORS"
Main authors and maintainers:
.PP
Andrea Lo Pumo aka AlpT <alpt@freaknet.org>
.PP
Main contributors:
.PP
Andrea Leofreddi <andrea.leofreddi@gmail.com>, Katolaz <katolaz@freaknet.org>,
Federico Tomassini <effetom@gmail.com>
.PP
For a complete list read the \s-1AUTHORS\s0 file or visit:
    <http://netsukuku.freaknet.org/?p=Contacts>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For more information about Netsukuku visit:
    <http://netsukuku.freaknet.org>
.PP
\&\fIntkd\fR\|(8), \fIntk\-wifi\fR\|(8), \fIandna\fR\|(8), \fIiproute2\fR\|(8), \fIroute\fR\|(8)