1VTUND.CONF(5) File Formats Manual VTUND.CONF(5)
2
6 vtund.conf - VTun(Virtual Tunnel) daemon configuration file.
7
10 Configuration file for vtund(8) virtual tunnel daemon.
11 File consists of sections in the form:
13 name {
15 keyword value;
16 keyword value;
17 ..
18 }
19 Semicolon at the end of each keyword-value pair is required, as well as
22 grouping curly braces {}. Lines which begin with '#' characters are
23 comments.
24 Name of section (name) can be one of:
26 options
28 this section specifies general options for vtund
29 default
31 specifies default options for all sessions
32 session
34 (any other word except "options" and "default") introduces new
35 session and specifies options for it.
36 All keyword names can be abbreviated to a minimum of 4 characters.
38
40 This section, named options, specifies general options to use by
41 vtund(8). Possible keywords are:
42 type stand|inetd
44 server type. vtund(8) can operate in standalone mode (stand),
45 that is the default, or be invoked from inetd(8).
46 port portnumber
49 server port number to listen on or connect to. By default,
50 vtund(8) uses port 5000.
51 bindaddr list
54 server listen address. Used to force vtund to bind to the spe‐
55 cific address and port in server mode. Format:
56 bindaddr {
57 option value;
58 };
59 bindaddr options:
61 iface if_name
63 use interface address if_name as the bind address.
64 addr addr
66 bind address. Can be either IP address or host name.
67 timeout seconds
70 General timeout.
71 persist yes|keep|no
74 persist mode. If yes, the client will try to reconnect to the
75 server after connection termination. If keep, the client will
76 not remove and re-add the tunXX or tapXX device when reconnect‐
77 ing. If no, the client will exit (default). This option is
78 ignored by the server.
79 syslog number|name
82 syslog facility specification, either numeric or name (from sys‐
83 log (3)).
84 ppp path
87 path to pppd(8) program. Can be used in session sections.
88 ifconfig path
91 path to ifconfig(8) program. Can be used in session sections.
92 route path
95 path to route(8) program. Can be used in session sections.
96 ip path
99 path to iproute(8) program. Can be used in session sections.
100 firewall path
103 program for the firewall setup.
104 All the ppp, ifconfig, route and firewall parameters can specify a
107 filename for corresponding program or equivalent (or shell script).
108 This parameters are used in session sections to setup network inter‐
109 faces.
110
113 Session options can be specified inside session section or inside
114 default section. Default parameters apply to any session section but
115 can be overwritten there. Parameters are:
116 passwd secret
119 password for authentication. This should be the same in client
120 and server.
121 type type
124 type of tunnel. Possible tunnel types are:
125 tun IP tunnel (no PPP, Ether etc headers)
127 ether Ethernet tunnel
129 tty serial tunnel (PPP, SLIP etc)
131 pipe pipe tunnel
133 Default tunnel type is tty. This option is ignored by client.
135 device dev
138 network device to use. You can choose tapXX for ether tunnel or
139 tunXX for tun tunnel. By default vtund(8) will automatically
140 select available device.
141 proto tcp|udp
144 protocol to use. By default, vtund(8) will use TCP protocol.
145 UDP is recommended for ether and tun tunnels only. This option
146 is ignored by the client.
147 timeout secounds
150 Connect timeout.
151 compress method[:level]
154 specifies compression method to use. Compression methods
155 includes:
156 no no compression
158 yes default compression method
160 zlib ZLIB compression
162 lzo LZO compression (if compiled in)
164 You can also specify level of compression using one digit (1 is
166 best speed, 9 is best compression ratio). This option ignored
167 by the client.
168 encrypt yes|no
170 enable or disable encryption. This option ignored by the
171 client.
172 keepalive yes|no
174 enable or disable connection keep-alive. This option is ignored
175 by the client.
176 stat yes|no
178 enable or disable statistics. If enabled vtund(8) will log
179 statistic counters to /var/log/vtund/session_X every 5 minutes.
180 speed kbps
182 specifies speed of the connection in kilobits/second. Valid
183 values for kbps are 8,16,32,64,128,256,etc. 0 (the default)
184 means maximum possible speed without shaping. You can specify
185 speed in form in:out, where in is speed to client, out - from
186 the client. Single number means the same speed for in and out.
187 This option ignored by the client.
188 srcaddr list
190 local (source) address. Used to force vtund to bind to the spe‐
191 cific address and port. Format:
192 srcaddr {
193 option value;
194 option value;
195 ..
196 };
197 srcaddr options:
199 iface if_name
201 use interface address if_name as the source address.
202 addr addr
204 source address. Can be either IP address or host name.
205 port portnumber
207 source port.
208 multi value
210 control multiple connections. value can be yes or allow to
211 allow multiple connections, no or deny to deny them or killold
212 to allow new connection and kill old one. Ignored by the
213 client.
214 up list
216 list of programs to run after connection has been established.
217 Used to initialize protocols, devices, routing and firewall.
218 This option looks like whole section inside of session section.
219 Format:
220 up {
221 option value;
222 option value;
223 ..
224 };
225 Options inside up (and down) blocks:
227 program path arguments [wait]
229 run specified program. path is the full path to the pro‐
230 gram, arguments is all arguments to pass to it (enclosed
231 in double quotes). If wait specified, vtund will wait
232 program termination. Special characters that can be used
233 inside arguments parameter:
234 ´ (single quotes) - group arguments
236 \ (back slash) - escape character
237 %d - TUN or TAP device or TTY port name
238 %% (double percent) - same as %d
239 %A - Local IP address
240 %P - Local TCP or UDP port
241 %a - Remote IP address
242 %p - Remote TCP or UDP port
243 ppp arguments
245 run program specified by ppp statement in options sec‐
246 tion. All special character described above are valid in
247 arguments here.
248 ifconfig arguments
250 run program specified by ifconfig statement in options
251 section.
252 route arguments
254 run program specified by route statement in options sec‐
255 tion.
256 ip arguments
258 run program specified by ip statement in options section.
259 firewall arguments
261 run program specified by firewall statement in options
262 section.
263 down list
265 list of programs to run after connection has been terminated.
266 It is similar to up parameter above. Format:
267 down {
268 option value;
269 option value;
270 ..
271 };
272
275 Options ignored by the client are supplied by the server at the run
276 time or are used only on the server side.
277
280 vtund(8), inetd(8), ifconfig(8), route(8), pppd(8), syslog(3), zlib(3).
281
284 Vtund written by Maxim Krasnyansky <max_mk@yahoo.com>. This manual
285 page was derived from comments in config file by Michael Tokarev
286 <mjt@tls.msk.ru>
287 VTUND.CONF(5)