1MIREDO.CONF(5) System Manager's Manual MIREDO.CONF(5)
2
6 miredo.conf - configuration for Miredo
7
9 miredo.conf
10
13 miredo.conf is the configuration file for Miredo. Each configuration
14 directive consists of one directive name, possibly followed by one or
15 several spaces and a value for the directive. White spaces, empty
16 lines and lines starting with '#' are ignored.
17 Directives are case-insensitive. A comprehensive list of the supported
19 directives follows:
20
23 RelayType (client|autoclient|relay|cone|restricted)
24 Specifies what type of Teredo relay/client Miredo will serve as.
25 There are three possible choices:
26 client mode (the default)
29 In client mode, Miredo acts as a Teredo client. Miredo will
30 first authenticate with a Teredo server (see ServerAddress), and
31 if successful, will setup a Teredo tunneling interface with a
32 public Teredo IPv6 address and a default IPv6 route. That vir‐
33 tual networking interface can be used to reach the IPv6 Internet
34 as well as Teredo clients.
35 The use of Miredo as a Teredo client allows nodes to get an IPv6
37 connectivity from behind a NAT router device, as it tunnels IPv6
38 packets over UDP/IPv4 with special support for NAT routers.
39 Routers of that kind usually only forward TCP, UDP, and some
40 ICMP, IPv4 packets (with some limitation).
41 NOTE: Use of Miredo as a Teredo client is possible even if the
43 system already has IPv6 connectivity through another way
44 (native, 6to4, TSP, etc). In that case, Miredo will only be used
45 to reach other Teredo clients, as its tunneling interface has a
46 default route with a higher metric (which is to say a lower pri‐
47 ority) than the other network interfaces.
48 autoclient is currently an alias for client mode.
51 cone mode (relay also works)
54 In cone mode, Miredo acts as a Teredo relay. It will assume that
55 it has public global IPv4 connectivity with no firewall. In
56 other words, the UDP port used by Miredo must receive
57 unsoliticited traffic from the IPv4 Internet (see also Bind‐
58 Port). Miredo will create a virtual networking interface with a
59 route toward Teredo clients.
60 Teredo relays forward IPv6 packets between Teredo clients and
62 the IPv6 Internet. For that to work, Teredo relays MUST have a
63 working IPv6 connectivity through a way distinct from Teredo
64 tunneling (native, 6to4, ISATAP, etc).
65 Warning: This mode should only be used if the node has a public
67 IPv4 address, or if it is behind a full cone NAT-router with
68 proper port forwarding rules. Otherwise the tunnel will NOT
69 WORK PROPERLY. Note that many NAT port forwarding implementa‐
70 tions are broken.
71 restricted mode
74 This mode is identical to the cone mode documented above, with
75 the exception that direct Teredo bubbles will be sent. Theoret‐
76 ically (see RFC4380) this permits operation of a Teredo relay
77 from behind a restricted-port NAT. In practice, this makes NAT
78 traversal extremely unreliable. This setting is present for
79 backward syntax compatibility of the miredo.conf file. PLEASE DO
80 NOT USE THIS MODE.
81
84 The following directives are only available in (auto)client mode.
85 ServerAddress hostname
88 The ServerAddress directive specifies the hostname or numerical
89 IPv4 address of the Teredo server to use. Teredo clients needs
90 a Teredo server to establish and maintain their IPv6 over
91 UDP/IPv4 tunnel across a NAT device.
92 This directive MUST be specified when Miredo is in client mode.
94 hostname must resolve to a valid IPv4 address. If it is not
95 present, and no server hostname is specified on the command line
96 when starting miredo either, the program will fail.
97 ServerAddress2 hostname2
100 Miredo assumes that the secondary Teredo server address equals
101 the primary server address plus one. If that is not the case,
102 this directive must be used.
103
106 The following directives are only available in relay mode. They are
107 not available in (auto)client mode.
108 Prefix teredo_prefix
111 This directive specifies the Teredo prefix which the Teredo
112 relay and/or server will advertise. teredo_prefix must be a
113 valid IPv6 prefix.
114 The default value is 2001:0000::.
116 Do not use that directive if you don't know what you are doing,
118 as it is more than likely to break your Teredo connectivity.
119 That option must not be used when Miredo serves as a Teredo
120 client.
121 InterfaceMTU mtu
124 This directive overrides the default MTU size of 1280 bytes for
125 the Teredo tunneling interface. It should not be used if the
126 default Teredo prefix is used.
127
130 InterfaceName ifname
131 Specify the name of the Teredo tunneling interface which Miredo
132 will create ("miredo" by default). On some systems, it is not
133 possible to redefine the tunnel name.
134 BindAddress bind_address
137 Bind the Teredo relay or Teredo client to a specific IPv4
138 address. By default, it is not bound to any particular IPv4
139 address.
140 Use this option if you have trouble with the default value, such
142 as if you have a multi-homed host with equal-cost IPv4 routing,
143 or if you have specific firewalling constraints.
144 BindPort udp_port
147 Define the UDP (IPv4) port number to be used by the relay or
148 client. By default, the operating system allocates an unused
149 port automatically.
150 Use this option if you have firewalling constraints which can
152 cause Miredo to fail when not using a fixed predefined port.
153 SyslogFacility facility
156 Specify which syslog's facility is to be used by Miredo for log‐
157 ging. Possible values are: daemon (the default), local0, ...
158 local7, kern and user (see syslog(2)).
159
162 miredo(8)
163
166 Rémi Denis-Courmont <remi at remlab dot net>
167 http://www.remlab.net/miredo/
169miredo August 2007 MIREDO.CONF(5)