1.. _munin-node.conf:
2
3===============
4munin-node.conf
5===============
6
7DESCRIPTION
8===========
9
10This is the configuration file for :ref:`munin-node` and :ref:`munin-run`.
11
12The directives "host_name", "paranoia" and "ignore_file" are munin
13node specific.
14
15All other directives in munin-node.conf are passed through to the Perl
16module Net::Server. Depending on the version installed, you may have
17different settings available.
18
19DIRECTIVES
20==========
21
22Native
23------
24
25.. option:: host_name
26
27   The hostname used by munin-node to present itself to the munin
28   master. Use this if the local node name differs from the name
29   configured in the munin master.
30
31.. option:: ignore_file
32
33   Files to ignore when locating installed plugins. May be repeated.
34
35.. option:: paranoia
36
37   If set to a true value, :ref:`munin-node` will only run plugins
38   owned by root.
39
40Inherited
41---------
42
43These are the most common Net::Server options used in
44:ref:`munin-node`.
45
46.. option:: log_level
47
48   Ranges from 0-4. Specifies what level of error will be logged. "0"
49   means no logigng, while "4" means very verbose. These levels
50   correlate to syslog levels as defined by the following key/value
51   pairs. 0=err, 1=warning, 2=notice, 3=info, 4=debug.
52
53   Default: 2
54
55.. option:: log_file
56
57   Where the munin node logs its activity. If the value is
58   Sys::Syslog, logging is sent to syslog
59
60   Default: undef (STDERR)
61
62.. option:: port
63
64   The TCP port the munin node listens on
65
66   Default: 4949
67
68.. option:: pid_file
69
70   The pid file of the process
71
72   Default: undef (none)
73
74.. option:: background
75
76   To run munin node in background set this to "1". If you want
77   munin-node to run as a foreground process, comment this line out
78   and set "setsid" to "0".
79
80.. option:: host
81
82   The IP address the munin node process listens on
83
84   Default: * (All interfaces)
85
86.. option:: user
87
88   The user munin-node runs as
89
90   Default: root
91
92.. option:: group
93
94   The group munin-node runs as
95
96   Default: root
97
98.. option:: setsid
99
100   If set to "1", the server forks after binding to release itself
101   from the command line, and runs the POSIX::setsid() command to
102   daemonize.
103
104   Default: undef
105
106.. option:: ignore_file
107
108   Files to ignore when locating installed plugins. May be repeated.
109
110.. option:: host_name
111
112   The hostname used by munin-node to present itself to the munin
113   master. Use this if the local node name differs from the name
114   configured in the munin master.
115
116.. option:: allow
117
118   A regular expression defining which hosts may connect to the munin
119   node.
120
121   .. note:: Use cidr_allow if available.
122
123.. option:: cidr_allow
124
125   Allowed hosts given in CIDR notation (192.0.2.1/32). Replaces or
126   complements “allow”. Requires the presence of Net::Server, but is
127   not supported by old versions of this module.
128
129.. option:: cidr_deny
130
131   Like cidr_allow, but used for denying host access
132
133.. option:: timeout
134
135   Number of seconds after the last activity by the master until the
136   node will close the connection.
137
138   If plugins take longer to run, this may disconnect the master.
139
140   Default: 20 seconds
141
142EXAMPLE
143=======
144
145.. index::
146   tuple: munin-node.conf; example
147
148A pretty normal configuration file:
149
150::
151
152  host *
153  port 4949
154
155  cidr_allow 127.0.0.0/8
156  cidr_allow 192.0.2.0/24
157
158  user       root
159  group      root
160  background 1
161  setsid     1
162
163  log_level 4
164  log_file  /var/log/munin/munin-node.log
165  pid_file  /var/run/munin-node.pid
166
167  ignore_file \.bak$
168  ignore_file ^README$
169  ignore_file \.dpkg-(old|new)$
170  ignore_file \.rpm(save|new)$
171  ignore_file \.puppet-new$
172
173SEE ALSO
174========
175
176:ref:`munin-node`, :ref:`munin-run`
177