… | |
… | |
2 | |
2 | |
3 | gvpe.conf - configuration file for the GNU VPE daemon |
3 | gvpe.conf - configuration file for the GNU VPE daemon |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | enable-udp = yes |
|
|
8 | udp-port = 407 |
7 | udp-port = 407 |
9 | mtu = 1492 |
8 | mtu = 1492 |
10 | ifname = vpn0 |
9 | ifname = vpn0 |
11 | |
10 | |
12 | node = branch1 |
11 | node = branch1 |
… | |
… | |
61 | values on different nodes using C<on>), but will affect the behaviour of |
60 | values on different nodes using C<on>), but will affect the behaviour of |
62 | the gvpe daemon and all connections it creates. |
61 | the gvpe daemon and all connections it creates. |
63 | |
62 | |
64 | =over 4 |
63 | =over 4 |
65 | |
64 | |
66 | =item loglevel = noise|trace|debug|info|notice|warn|error|critical |
65 | =item dns-forw-host = hostname/ip |
67 | |
66 | |
68 | Set the logging level. Connection established messages are logged at level |
67 | The dns server to forward dns requests to for the DNS tunnel protocol |
69 | C<info>, notable errors are logged with C<error>. Default is C<info>. |
68 | (default: C<127.0.0.1>, changing it is highly recommended). |
70 | |
69 | |
71 | =item node = nickname |
70 | =item dns-forw-port = port-number |
72 | |
71 | |
73 | Not really a config setting but introduces a node section. The nickname is |
72 | The port where the C<dns-forw-host> is to be contacted (default: C<53>, |
74 | used to select the right configuration section and must be passed as an |
73 | which is fine in most cases). |
75 | argument to the gvpe daemon. |
|
|
76 | |
74 | |
77 | =item private-key = relative-path-to-key |
75 | =item if-up = relative-or-absolute-path |
78 | |
76 | |
79 | Sets the path (relative to the config directory) to the private key |
77 | Sets the path of a script that should be called immediately after the |
80 | (default: C<hostkey>). This is a printf format string so every C<%> must |
78 | network interface is initialized (but not neccessarily up). The following |
81 | be doubled. A single C<%s> is replaced by the hostname, so you could |
79 | environment variables are passed to it (the values are just examples): |
82 | use paths like C<hostkeys/%s> to fetch the files at the location where |
|
|
83 | C<gvpectrl> puts them. |
|
|
84 | |
80 | |
85 | Since only the private key file of the current node is used and the |
81 | =over 4 |
86 | private key file should be kept secret per-host to avoid spoofings, it is |
82 | |
87 | not recommended to use this feature. |
83 | =item CONFBASE=/etc/gvpe |
|
|
84 | |
|
|
85 | The configuration base directory. |
|
|
86 | |
|
|
87 | =item IFNAME=vpn0 |
|
|
88 | |
|
|
89 | The interface to initialize. |
|
|
90 | |
|
|
91 | =item MTU=1436 |
|
|
92 | |
|
|
93 | The MTU to set the interface to. You can use lower values (if done |
|
|
94 | consistently on all hosts), but this is usually ineffective. |
|
|
95 | |
|
|
96 | =item MAC=fe:fd:80:00:00:01 |
|
|
97 | |
|
|
98 | The MAC address to set the interface to. The script *must* set the |
|
|
99 | interface MAC to this value. You will most likely use one of these: |
|
|
100 | |
|
|
101 | ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
102 | ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
|
|
103 | |
|
|
104 | Please see the C<gvpe.osdep(5)> manpage for platform-specific information. |
|
|
105 | |
|
|
106 | =item IFTYPE=native # or tincd |
|
|
107 | |
|
|
108 | =item IFSUBTYPE=linux # or freebsd, darwin etc.. |
|
|
109 | |
|
|
110 | The interface type (C<native> or C<tincd>) and the subtype (usually the os |
|
|
111 | name in lowercase) that this gvpe was configured for. Can be used to select |
|
|
112 | the correct syntax to use for network-related commands. |
|
|
113 | |
|
|
114 | =item NODENAME=branch1 |
|
|
115 | |
|
|
116 | The nickname of the current node, as passed to the gvpe daemon. |
|
|
117 | |
|
|
118 | =item NODEID=1 |
|
|
119 | |
|
|
120 | The numerical node id of the current node. The first node mentioned in the |
|
|
121 | config file gets ID 1, the second ID 2 and so on. |
|
|
122 | |
|
|
123 | =back |
|
|
124 | |
|
|
125 | Here is a simple if-up script: |
|
|
126 | |
|
|
127 | #!/bin/sh |
|
|
128 | ip link set $IFNAME address $MAC mtu $MTU up |
|
|
129 | [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
|
|
130 | [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
|
|
131 | ip route add 10.0.0.0/8 dev $IFNAME |
|
|
132 | |
|
|
133 | More complicated examples (using routing to reduce arp traffic) can be |
|
|
134 | found in the etc/ subdirectory of the distribution. |
|
|
135 | |
|
|
136 | =item ifname = devname |
|
|
137 | |
|
|
138 | Sets the tun interface name to the given name. The default is OS-specific |
|
|
139 | and most probably something like C<tun0>. |
88 | |
140 | |
89 | =item ifpersist = yes|true|on | no|false|off |
141 | =item ifpersist = yes|true|on | no|false|off |
90 | |
142 | |
91 | Should the tun/tap device be made persistent, that is, should the device |
143 | Should the tun/tap device be made persistent, that is, should the device |
92 | stay up even when gvpe exits? Some versions of the tunnel device have |
144 | stay up even when gvpe exits? Some versions of the tunnel device have |
93 | problems sending packets when gvpe is restarted in persistent mode, so |
145 | problems sending packets when gvpe is restarted in persistent mode, so |
94 | if the connections can be established but you cannot send packets from |
146 | if the connections can be established but you cannot send packets from |
95 | the local node, try to set this to C<off> and do an ifconfig down on the |
147 | the local node, try to set this to C<off> and do an ifconfig down on the |
96 | device. |
148 | device. |
97 | |
149 | |
98 | =item ifname = devname |
150 | =item ip-proto = numerical-ip-protocol |
99 | |
151 | |
100 | Sets the tun interface name to the given name. The default is OS-specific |
152 | Sets the protocol number to be used for the rawip protocol. This is a |
101 | and most probably something like C<tun0>. |
153 | global option because all hosts must use the same protocol, and since |
|
|
154 | there are no port numbers, you cannot easily run more than one gvpe |
|
|
155 | instance using the same protocol, nor can you share the protocol with |
|
|
156 | other programs. |
102 | |
157 | |
103 | =item rekey = seconds |
158 | The default is 47 (GRE), which has a good chance of tunneling through |
|
|
159 | firewalls (but note that the rawip protocol is not GRE compatible). Other |
|
|
160 | common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98 |
|
|
161 | (ENCAP, rfc1241) |
104 | |
162 | |
105 | Sets the rekeying interval in seconds (default: C<3600>). Connections are |
163 | =item http-proxy-host = hostname/ip |
106 | reestablished every C<rekey> seconds. |
164 | |
|
|
165 | The C<http-proxy-*> family of options are only available if gvpe was |
|
|
166 | compiled with the C<--enable-http-proxy> option and enable tunneling of |
|
|
167 | tcp connections through a http proxy server. |
|
|
168 | |
|
|
169 | C<http-proxy-host> and C<http-proxy-port> should specify the hostname and |
|
|
170 | port number of the proxy server. See C<http-proxy-loginpw> if your proxy |
|
|
171 | requires authentication. |
|
|
172 | |
|
|
173 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
174 | configuration file, so if you are behind a proxy without access to a dns |
|
|
175 | server better use numerical IP addresses. |
|
|
176 | |
|
|
177 | To make best use of this option disable all protocols except tcp in your |
|
|
178 | config file and make sure your routers (or all other hosts) are listening |
|
|
179 | on a port that the proxy allows (443, https, is a common choice). |
|
|
180 | |
|
|
181 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
182 | enabled on all hosts. |
|
|
183 | |
|
|
184 | Example: |
|
|
185 | |
|
|
186 | http-proxy-host = proxy.example.com |
|
|
187 | http-proxy-port = 3128 # 8080 is another common choice |
|
|
188 | http-proxy-auth = schmorp:grumbeere |
|
|
189 | |
|
|
190 | =item http-proxy-port = proxy-tcp-port |
|
|
191 | |
|
|
192 | The port where your proxy server listens. |
|
|
193 | |
|
|
194 | =item http-proxy-auth = login:password |
|
|
195 | |
|
|
196 | The optional login and password used to authenticate to the proxy server, |
|
|
197 | seperated by a literal colon (C<:>). Only basic authentication is |
|
|
198 | currently supported. |
107 | |
199 | |
108 | =item keepalive = seconds |
200 | =item keepalive = seconds |
109 | |
201 | |
110 | Sets the keepalive probe interval in seconds (default: C<60>). After this |
202 | Sets the keepalive probe interval in seconds (default: C<60>). After this |
111 | many seconds of inactivity the daemon will start to send keepalive probe |
203 | many seconds of inactivity the daemon will start to send keepalive probe |
112 | every 5 seconds until it receives a reply from the other end. If no reply |
204 | every 5 seconds until it receives a reply from the other end. If no reply |
113 | is received within 30 seconds, the peer is considered unreachable and the |
205 | is received within 30 seconds, the peer is considered unreachable and the |
114 | connection is closed. |
206 | connection is closed. |
115 | |
207 | |
|
|
208 | =item loglevel = noise|trace|debug|info|notice|warn|error|critical |
|
|
209 | |
|
|
210 | Set the logging level. Connection established messages are logged at level |
|
|
211 | C<info>, notable errors are logged with C<error>. Default is C<info>. |
|
|
212 | |
116 | =item mtu = bytes |
213 | =item mtu = bytes |
117 | |
214 | |
118 | Sets the maximum MTU that should be used on outgoing packets (basically |
215 | Sets the maximum MTU that should be used on outgoing packets (basically |
119 | the MTU of the outgoing interface) The daemon will automatically calculate |
216 | the MTU of the outgoing interface) The daemon will automatically calculate |
120 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
217 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
… | |
… | |
122 | |
219 | |
123 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
220 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
124 | |
221 | |
125 | This value must be the minimum of the mtu values of all hosts. |
222 | This value must be the minimum of the mtu values of all hosts. |
126 | |
223 | |
127 | =item ip-proto = numerical-ip-protocol |
224 | =item node = nickname |
128 | |
225 | |
129 | Sets the protocol number to be used for the rawip protocol. This is a |
226 | Not really a config setting but introduces a node section. The nickname is |
130 | global option because all hosts must use the same protocol, and since |
227 | used to select the right configuration section and must be passed as an |
131 | there are no port numbers, you cannot easily run more than one gvpe |
228 | argument to the gvpe daemon. |
132 | instance using the same protocol, nor can you share the protocol with |
|
|
133 | other programs. |
|
|
134 | |
|
|
135 | The default is 47 (GRE), which has a good chance of tunneling through |
|
|
136 | firewalls (but note that the rawip protocol is not GRE compatible). Other |
|
|
137 | common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98 |
|
|
138 | (ENCAP, rfc1241) |
|
|
139 | |
|
|
140 | =item if-up = relative-or-absolute-path |
|
|
141 | |
|
|
142 | Sets the path of a script that should be called immediately after the |
|
|
143 | network interface is initialized (but not neccessarily up). The following |
|
|
144 | environment variables are passed to it (the values are just examples): |
|
|
145 | |
|
|
146 | =over 4 |
|
|
147 | |
|
|
148 | =item CONFBASE=/etc/gvpe |
|
|
149 | |
|
|
150 | The configuration base directory. |
|
|
151 | |
|
|
152 | =item IFNAME=vpn0 |
|
|
153 | |
|
|
154 | The interface to initialize. |
|
|
155 | |
|
|
156 | =item MTU=1436 |
|
|
157 | |
|
|
158 | The MTU to set the interface to. You can use lower values (if done |
|
|
159 | consistently on all hosts), but this is usually ineffective. |
|
|
160 | |
|
|
161 | =item MAC=fe:fd:80:00:00:01 |
|
|
162 | |
|
|
163 | The MAC address to set the interface to. The script *must* set the |
|
|
164 | interface MAC to this value. You will most likely use one of these: |
|
|
165 | |
|
|
166 | ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
167 | ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
|
|
168 | |
|
|
169 | Please see the C<gvpe.osdep(5)> manpage for platform-specific information. |
|
|
170 | |
|
|
171 | =item IFTYPE=native # or tincd |
|
|
172 | |
|
|
173 | =item IFSUBTYPE=linux # or freebsd, darwin etc.. |
|
|
174 | |
|
|
175 | The interface type (C<native> or C<tincd>) and the subtype (usually the os |
|
|
176 | name in lowercase) that this gvpe was configured for. Can be used to select |
|
|
177 | the correct syntax to use for network-related commands. |
|
|
178 | |
|
|
179 | =item NODENAME=branch1 |
|
|
180 | |
|
|
181 | The nickname of the current node, as passed to the gvpe daemon. |
|
|
182 | |
|
|
183 | =item NODEID=1 |
|
|
184 | |
|
|
185 | The numerical node id of the current node. The first node mentioned in the |
|
|
186 | config file gets ID 1, the second ID 2 and so on. |
|
|
187 | |
|
|
188 | =back |
|
|
189 | |
|
|
190 | Here is a simple if-up script: |
|
|
191 | |
|
|
192 | #!/bin/sh |
|
|
193 | ip link set $IFNAME address $MAC mtu $MTU up |
|
|
194 | [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
|
|
195 | [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
|
|
196 | ip route add 10.0.0.0/8 dev $IFNAME |
|
|
197 | |
|
|
198 | More complicated examples (using routing to reduce arp traffic) can be |
|
|
199 | found in the etc/ subdirectory of the distribution. |
|
|
200 | |
229 | |
201 | =item node-up = relative-or-absolute-path |
230 | =item node-up = relative-or-absolute-path |
202 | |
231 | |
203 | Sets a command (default: no script) that should be called whenever a |
232 | Sets a command (default: no script) that should be called whenever a |
204 | connection is established (even on rekeying operations). In addition |
233 | connection is established (even on rekeying operations). In addition |
… | |
… | |
243 | |
272 | |
244 | =item node-down = relative-or-absolute-path |
273 | =item node-down = relative-or-absolute-path |
245 | |
274 | |
246 | Same as C<node-up>, but gets called whenever a connection is lost. |
275 | Same as C<node-up>, but gets called whenever a connection is lost. |
247 | |
276 | |
248 | =item http-proxy-host = hostname/ip |
|
|
249 | |
|
|
250 | The C<http-proxy-*> family of options are only available if gvpe was |
|
|
251 | compiled with the C<--enable-http-proxy> option and enable tunneling of |
|
|
252 | tcp connections through a http proxy server. |
|
|
253 | |
|
|
254 | C<http-proxy-host> and C<http-proxy-port> should specify the hostname and |
|
|
255 | port number of the proxy server. See C<http-proxy-loginpw> if your proxy |
|
|
256 | requires authentication. |
|
|
257 | |
|
|
258 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
259 | configuration file, so if you are behind a proxy without access to a dns |
|
|
260 | server better use numerical IP addresses. |
|
|
261 | |
|
|
262 | To make best use of this option disable all protocols except tcp in your |
|
|
263 | config file and make sure your routers (or all other hosts) are listening |
|
|
264 | on a port that the proxy allows (443, https, is a common choice). |
|
|
265 | |
|
|
266 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
267 | enabled on all hosts. |
|
|
268 | |
|
|
269 | Example: |
|
|
270 | |
|
|
271 | http-proxy-host = proxy.example.com |
|
|
272 | http-proxy-port = 3128 # 8080 is another common choice |
|
|
273 | http-proxy-auth = schmorp:grumbeere |
|
|
274 | |
|
|
275 | =item http-proxy-port = proxy-tcp-port |
|
|
276 | |
|
|
277 | The port where your proxy server listens. |
|
|
278 | |
|
|
279 | =item http-proxy-auth = login:password |
|
|
280 | |
|
|
281 | The optional login and password used to authenticate to the proxy server, |
|
|
282 | seperated by a literal colon (C<:>). Only basic authentication is |
|
|
283 | currently supported. |
|
|
284 | |
|
|
285 | =item pid-file = path |
277 | =item pid-file = path |
286 | |
278 | |
287 | The path to the pid file to check and create (Default: |
279 | The path to the pid file to check and create |
|
|
280 | (default: C<LOCALSTATEDIR/run/gvpe.pid>). |
|
|
281 | |
|
|
282 | =item private-key = relative-path-to-key |
|
|
283 | |
|
|
284 | Sets the path (relative to the config directory) to the private key |
|
|
285 | (default: C<hostkey>). This is a printf format string so every C<%> must |
|
|
286 | be doubled. A single C<%s> is replaced by the hostname, so you could |
|
|
287 | use paths like C<hostkeys/%s> to fetch the files at the location where |
|
|
288 | C<gvpectrl> puts them. |
|
|
289 | |
|
|
290 | Since only the private key file of the current node is used and the |
|
|
291 | private key file should be kept secret per-host to avoid spoofings, it is |
|
|
292 | not recommended to use this feature. |
|
|
293 | |
|
|
294 | =item rekey = seconds |
|
|
295 | |
|
|
296 | Sets the rekeying interval in seconds (default: C<3600>). Connections are |
|
|
297 | reestablished every C<rekey> seconds. |
288 | |
298 | |
289 | =back |
299 | =back |
290 | |
300 | |
291 | =head2 NODE SPECIFIC SETTINGS |
301 | =head2 NODE SPECIFIC SETTINGS |
292 | |
302 | |
… | |
… | |
295 | executed before the first node section set the defaults, settings that are |
305 | executed before the first node section set the defaults, settings that are |
296 | executed within a node section only apply to the given node. |
306 | executed within a node section only apply to the given node. |
297 | |
307 | |
298 | =over 4 |
308 | =over 4 |
299 | |
309 | |
|
|
310 | =item compress = yes|true|on | no|false|off |
|
|
311 | |
|
|
312 | Wether to compress data packets sent to this host (default: C<yes>). |
|
|
313 | Compression is really cheap even on slow computers and has no size |
|
|
314 | overhead at all, so enabling this is a good idea. |
|
|
315 | |
|
|
316 | =item connect = ondemand | never | always | disabled |
|
|
317 | |
|
|
318 | Sets the connect mode (default: C<always>). It can be C<always> (always |
|
|
319 | try to establish and keep a connection to the given host), C<never> |
|
|
320 | (never initiate a connection to the given host, but accept connections), |
|
|
321 | C<ondemand> (try to establish a connection on the first packet sent, and |
|
|
322 | take it down after the keepalive interval) or C<disabled> (node is bad, |
|
|
323 | don't talk to it). |
|
|
324 | |
|
|
325 | =item dns-domain = domain-suffix |
|
|
326 | |
|
|
327 | The DNS domain suffix that points to the DNS tunnel server for this node. |
|
|
328 | |
|
|
329 | The domain must point to a NS record that points to the I<dns-hostname>, |
|
|
330 | i.e. |
|
|
331 | |
|
|
332 | dns-domainname = tunnel.example.net |
|
|
333 | dns-hostname = tunnel-server.example.net |
|
|
334 | |
|
|
335 | Corresponds to the following DNS entries in the C<example.net> domain: |
|
|
336 | |
|
|
337 | tunnel.example.net. NS tunnel-server.example.net. |
|
|
338 | tunnel-server.example.net. A 13.13.13.13 |
|
|
339 | |
|
|
340 | =item dns-hostname = hostname/ip |
|
|
341 | |
|
|
342 | The address to bind the DNS tunnel socket to, similar to the C<hostname>, |
|
|
343 | but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might |
|
|
344 | change. |
|
|
345 | |
300 | =item udp-port = port-number |
346 | =item dns-port = port-number |
301 | |
347 | |
302 | Sets the port number used by the UDP protocol (default: C<655>, not |
348 | The port to bind the DNS tunnel socket to. Must be C<0> on all DNS tunnel |
303 | officially assigned by IANA!). |
349 | clients and C<53> on the server. |
304 | |
350 | |
305 | =item tcp-port = port-number |
351 | =item enable-dns = yes|true|on | no|false|off |
306 | |
352 | |
307 | Similar to C<udp-port> (default: C<655>), but sets the TCP port number. |
353 | Enable the DNS tunneling protocol on this node, either as server |
|
|
354 | C<dns-port != 0> or as client C<dns-port == 0> (both at the same time is |
|
|
355 | not possible at the moment). |
308 | |
356 | |
309 | =item enable-rawip = yes|true|on | no|false|off |
357 | =item enable-rawip = yes|true|on | no|false|off |
310 | |
358 | |
311 | Enable the RAW IPv4 transport using the C<ip-proto> protocol |
359 | Enable the RAW IPv4 transport using the C<ip-proto> protocol |
312 | (default: C<no>). This is the best choice, since the overhead per packet |
360 | (default: C<no>). This is the best choice, since the overhead per packet |
313 | is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+). |
361 | is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+). |
314 | |
|
|
315 | =item enable-udp = yes|true|on | no|false|off |
|
|
316 | |
|
|
317 | Enable the UDPv4 transport using the C<udp-port> port (default: C<yes>, |
|
|
318 | but this will change!). This is a good general choice since UDP tunnels |
|
|
319 | well through many firewalls. |
|
|
320 | |
|
|
321 | NOTE: Please specify C<enable-udp = yes> even though it is the default, as |
|
|
322 | some future version will have all protocols disabled by default. |
|
|
323 | |
362 | |
324 | =item enable-tcp = yes|true|on | no|false|off |
363 | =item enable-tcp = yes|true|on | no|false|off |
325 | |
364 | |
326 | Enable the TCPv4 transport using the C<tcp-port> port |
365 | Enable the TCPv4 transport using the C<tcp-port> port |
327 | (default: C<no>). Support for this horribly unsuitable protocol is only |
366 | (default: C<no>). Support for this horribly unsuitable protocol is only |
328 | available when gvpe was compiled using the C<--enable-tcp> option. Never |
367 | available when gvpe was compiled using the C<--enable-tcp> option. Never |
329 | use this transport unless you really must, it is horribly ineffiecent and |
368 | use this transport unless you really must, it is horribly ineffiecent and |
330 | resource-intensive compared to the other transports. |
369 | resource-intensive compared to the other transports. |
|
|
370 | |
|
|
371 | =item enable-udp = yes|true|on | no|false|off |
|
|
372 | |
|
|
373 | Enable the UDPv4 transport using the C<udp-port> port (default: C<no>, |
|
|
374 | unless no other protocol is enabled for a node, in which case this |
|
|
375 | protocol is enabled automatically). This is a good general choice since |
|
|
376 | UDP tunnels well through many firewalls. |
|
|
377 | |
|
|
378 | NOTE: Please specify C<enable-udp = yes> if you want t use it even though |
|
|
379 | it might get switched on automatically, as some future version might |
|
|
380 | default to another default protocol. |
|
|
381 | |
|
|
382 | =item inherit-tos = yes|true|on | no|false|off |
|
|
383 | |
|
|
384 | Wether to inherit the TOS settings of packets sent to the tunnel when |
|
|
385 | sending packets to this node (default: C<yes>). If set to C<yes> then |
|
|
386 | outgoing tunnel packets will have the same TOS setting as the packets sent |
|
|
387 | to the tunnel device, which is usually what you want. |
|
|
388 | |
|
|
389 | =item max-retry = positive-number |
|
|
390 | |
|
|
391 | The maximum interval in seconds (default: C<28800>, 8 hours) between |
|
|
392 | retries to establish a connection to this node. When a connection cannot |
|
|
393 | be established, gvpe uses exponential backoff capped at this value. It's |
|
|
394 | sometimes useful to set this to a much lower value (e.g. C<120>) on |
|
|
395 | connections to routers that usually are stable but sometimes are down, to |
|
|
396 | assure quick reconnections. |
331 | |
397 | |
332 | =item router-priority = 0 | 1 | positive-number>2 |
398 | =item router-priority = 0 | 1 | positive-number>2 |
333 | |
399 | |
334 | Sets the router priority of the given host (default: C<0>, disabled). If |
400 | Sets the router priority of the given host (default: C<0>, disabled). If |
335 | some host tries to connect to another host without a hostname, it asks |
401 | some host tries to connect to another host without a hostname, it asks |
… | |
… | |
345 | required, bump the C<router-priority> setting to higher than C<1> in their |
411 | required, bump the C<router-priority> setting to higher than C<1> in their |
346 | local config to route through specific hosts. If C<router-priority> is |
412 | local config to route through specific hosts. If C<router-priority> is |
347 | C<0>, then routing will be refused, so C<1> serves as a "enable, but do |
413 | C<0>, then routing will be refused, so C<1> serves as a "enable, but do |
348 | not use by default" switch. |
414 | not use by default" switch. |
349 | |
415 | |
350 | =item connect = ondemand | never | always | disabled |
416 | =item tcp-port = port-number |
351 | |
417 | |
352 | Sets the connect mode (default: C<always>). It can be C<always> (always |
418 | Similar to C<udp-port> (default: C<655>), but sets the TCP port number. |
353 | try to establish and keep a connection to the given host), C<never> |
|
|
354 | (nevr initiate a connection to the given host, but accept connections), |
|
|
355 | C<ondemand> (try to establish a connection on the first packet sent, and |
|
|
356 | take it down after the keepalive interval) or C<disabled> (node is bad, |
|
|
357 | don't talk to it). |
|
|
358 | |
419 | |
359 | =item inherit-tos = yes|true|on | no|false|off |
420 | =item udp-port = port-number |
360 | |
421 | |
361 | Wether to inherit the TOS settings of packets sent to the tunnel when |
422 | Sets the port number used by the UDP protocol (default: C<655>, not |
362 | sending packets to this node (default: C<yes>). If set to C<yes> then |
423 | officially assigned by IANA!). |
363 | outgoing tunnel packets will have the same TOS setting as the packets sent |
|
|
364 | to the tunnel device, which is usually what you want. |
|
|
365 | |
|
|
366 | =item compress = yes|true|on | no|false|off |
|
|
367 | |
|
|
368 | Wether to compress data packets sent to this host (default: C<yes>). |
|
|
369 | Compression is really cheap even on slow computers and has no size |
|
|
370 | overhead at all, so enabling this is a good idea. |
|
|
371 | |
|
|
372 | =item max-retry = positive-number |
|
|
373 | |
|
|
374 | The maximum interval in seconds (default: C<28800>, 8 hours) between |
|
|
375 | retries to establish a connection to this node. When a connection cannot |
|
|
376 | be established, gvpe uses exponential backoff capped at this value. It's |
|
|
377 | sometimes useful to set this to a much lower value (e.g. C<120>) on |
|
|
378 | connections to routers that usually are stable but sometimes are down, to |
|
|
379 | assure quick reconnections. |
|
|
380 | |
424 | |
381 | =back |
425 | =back |
382 | |
426 | |
383 | =head1 CONFIG DIRECTORY LAYOUT |
427 | =head1 CONFIG DIRECTORY LAYOUT |
384 | |
428 | |
385 | The default (or recommended) directory layout for the config directory is: |
429 | The default (or recommended) directory layout for the config directory is: |
386 | |
430 | |
387 | =over 4 |
431 | =over 4 |
388 | |
432 | |
389 | =item gvpe.conf |
433 | =item X<gvpe.conf> |
390 | |
434 | |
391 | The config file. |
435 | The config file. |
392 | |
436 | |
393 | =item if-up |
437 | =item X<if-up> |
394 | |
438 | |
395 | The if-up script |
439 | The if-up script |
396 | |
440 | |
397 | =item node-up, node-down |
441 | =item X<node-up>, X<node-down> |
398 | |
442 | |
399 | If used the node up or node-down scripts. |
443 | If used the node up or node-down scripts. |
400 | |
444 | |
401 | =item hostkey |
445 | =item X<hostkey> |
402 | |
446 | |
403 | The private key (taken from C<hostkeys/nodename>) of the current host. |
447 | The private key (taken from C<hostkeys/nodename>) of the current host. |
404 | |
448 | |
405 | =item pubkey/nodename |
449 | =item X<pubkey/nodename> |
406 | |
450 | |
407 | The public keys of the other nodes, one file per node. |
451 | The public keys of the other nodes, one file per node. |
408 | |
452 | |
409 | =back |
453 | =back |
410 | |
454 | |