We can now tell WLAN interfaces from wired interfaces on Windows.
[olsrd.git] / README-WIN32.txt
1
2                          olsr.org for Windows
3                          --------------------
4
5 Welcome to the Windows release of olsr.org. Let's have a quick look at
6 how this version differs from the original Linux version.
7
8
9                         ***** Stability *****
10
11   While the Windows version looks pretty stable in basic scenarios, it
12   hasn't yet received the extensive testing by the OLSR community that
13   the Linux version has gone through. So, if you experience any
14   strange behaviour, it's probably my fault. In this case please bear
15   with me and use the issue tracker on SourceForge. I'll then do my
16   best to find and fix the problem with your assistance. The
17   SourceForge homepage for olsrd.org has the following URL.
18
19                 http://sourceforge.net/projects/olsrd/
20
21
22                     ***** Configuration file *****
23
24   If you do not specify a configuration file, the OLSR server
25   ("olsrd.exe") by default attempts to use "olsrd.conf" in your
26   Windows directory, e.g. "C:\WINDOWS\olsrd.conf".
27
28
29                      ***** Interface naming *****
30
31   On Linux network interfaces have nice names like "eth0". In
32   contrast, Windows internally identifies network interfaces by pretty
33   awkward names, for example:
34
35     "{EECD2AB6-C2FC-4826-B92E-CAA53B29D67C}"
36
37   Hence, the Windows version implements its own naming scheme that
38   maps each internal name to a made-up name like "if03", which is
39   easier to memorize. Simply invoke the OLSR server as follows to
40   obtain its view of your interfaces:
41
42     olsrd.exe -int
43
44   This lists the made-up interface names along with their current IP
45   addresses to enable you to find out which made-up interface name
46   corresponds to which of your physical interfaces.
47
48   "+" in front of the IP addresses means that the OLSR server has
49   identified the interface as a WLAN interface. "-" indicates that the
50   OLSR server considers this interface to be a wired interface. "?"
51   means "no idea". Detection currently only works on NT, 2000, and
52   XP. Windows 9x and ME will always display "?".
53
54   For techies: The made-up names consist of the string "if" followed
55   by a two-digit hex representation of the least significant byte of
56   the Windows-internal interface index, which should be different for
57   each interface and thus make each made-up name unique. Again, this
58   is undocumented and this assumption may be wrong in certain
59   cases. So, if the "-int" option reports two interfaces that have the
60   same name, please do let me know.
61
62
63                      ***** Running the GUI *****
64
65   We now have a native Windows GUI. No more GTK+. Simply make sure
66   that "Switch.exe", "Shim.exe", and "olsrd.exe" are located in the
67   same directory and run "Switch.exe". "Shim.exe" is just an auxiliary
68   console application that is required by "Switch.exe".
69
70   The GUI is pretty self-explanatory. The three buttons on the lower
71   right of the GUI window start the OLSR server, stop the OLSR server,
72   and exit the GUI.
73
74   Use the "Settings" tab to specify the options that the GUI uses to
75   run the OLSR server "olsrd.exe". When you click "Start" the GUI
76   generates a temporary configuration file from the information given
77   by the "Settings" tab. This temporary configuration file is passed
78   to the OLSR server via its "-f" option. If you need options that
79   cannot be controlled via the "Settings" tab, simply add them to the
80   "Manual additions" text box as you would add them to a configuration
81   file, e.g. "HNA 192.168.0.0 255.255.255.0". The contents of this
82   text box are appended to the temporary configuration file when it is
83   generated.
84
85   "Offer Internet connection" is only available if you have an
86   Internet connection, i.e. if you have a default route configured. If
87   you tick this option, "HNA 0.0.0.0 0.0.0.0" is added to the
88   temporary configuration file, allowing other nodes in the OLSR
89   network to use your Internet connection.
90
91   Gateway tunnelling and IP version 6 cannot currently be selected, as
92   support for these features is not yet complete in the Windows
93   version.
94
95   The three buttons on the lower right of the "Settings" tab open
96   previously saved settings, save the current settings to a
97   configuration file, and reset the current settings to default
98   values. When opening a saved configuration file, the GUI adds lines
99   that it cannot interpret to the "Manual additions" text box.
100
101   If you start the GUI with the path to a configuration file as the
102   only command line argument, the GUI opens the given configuration
103   file and runs the OLSR server with this configuration. So, saving a
104   configuration file with a ".olsr" extension, for example, and making
105   "Switch.exe" the handler for ".olsr" files enables you to run the
106   OLSR server with a simple double click on the configuration file.
107
108   The "Output" tab shows the output of the currently running OLSR
109   server. When you click "Start" The GUI simply invokes the OLSR
110   server "olsrd.exe" and intercepts its console output. Use the four
111   buttons on the upper right of the tab to freeze the output, resume
112   frozen output, save the output to a file, or clear the output.
113
114   The "Nodes" tab contains information about the nodes that the OLSR
115   server currently knows about. If you click on the address of a node
116   in the "Node list" list box, the GUI populates the three "Node
117   information" list boxes on the right with the multi-point relays of
118   the selected node (MPR), the interfaces of the selected node (MID),
119   and the non-OLSR networks accessible via the selected node (HNA).
120
121   The "Routes" tab shows the routes that the currently running OLSR
122   server has added.
123
124
125                    ***** Running the GTK+ GUI *****
126
127   Please use the native Windows GUI instead. The GTK+ GUI is no longer
128   supported on Windows.
129
130
131                      ***** Missing features *****
132
133   The Windows version currently does not implement the following
134   features known from the Linux release.
135
136     * IPv6.
137
138     * Link layer statistics.
139
140     * Gateway tunnelling. This is currently experimental on
141       Windows. It is intended to work reliably on Windows 2000 and
142       Windows XP in a later version. It is based on the ipinip.sys
143       device driver that comes with these operating systems, but which
144       is completely undocumented. I've figured out how to use the
145       device driver, but it looks like I've still missed one or two
146       little things. So, tunnelling might work on your OS version, but
147       it might as well not work. Unfortunately, currently I do not
148       even know why it works on some systems and fails on other
149       systems.
150
151       If you are brave, do the following, but be prepared for a BSOD
152       (blue screen of death) as a worst-case scenario. This is nothing
153       for the faint of the heart. :-) Never try this on production
154       systems.
155
156         * Start the IP-in-IP tunnel driver before running the OLSR
157           server:
158
159             net start ipinip
160
161         * When the OLSR server reports that the tunnel has been
162           established, find out, which interface index the tunnel
163           device has been assigned:
164
165             route print
166
167         * Let's assume that the interface index is 0x1234 and the
168           gateway's IP address is 1.2.3.4. Manually add a default
169           route through the other end of the tunnel:
170
171             route add 0.0.0.0 mask 0.0.0.0 1.2.3.4 if 0x1234
172
173         * Try to ping somebody beyond the gateway and let me know
174           whether it works. If it doesn't and if you have time, please
175           do a packet dump for me to determine whether IP-in-IP
176           packets are leaving your system and, if yes, what they look
177           like.
178
179       If you know of any freely available tunnel driver for Windows,
180       please let me know. We could then think about switching from the
181       native ipinip.sys driver to an alternative driver, perhaps one
182       that also works on Windows 9x.
183
184       If you are the Microsoft person that is responsible for the
185       tunnel driver, please have a look at my code in
186       src/win32/tunnel.* and tell me what I'm missing.
187
188     * Multiple interfaces in the same subnet. As they all share the
189       same subnet broadcast address, there's no way to tell Windows
190       which of these interfaces to send OLSR packets through. I guess
191       that we'll have to come up with a device driver that sits
192       between the TCP/IP stack and the network adapters and that
193       directs outbound OLSR packets to the correct interface after
194       they've been routed by the TCP/IP stack. Looks like there isn't
195       any other solution on Windows.
196
197   There are also some Windows-specific features that I currently work
198   on, but which have not made it into this release.
199
200     * The option to run the OLSR server as a Windows service on
201       Windows NT, 2000, and XP.
202
203
204                         ***** Compiling *****
205
206   To compile the Windows version of the OLSR server or the dot_draw
207   plugin you need a Cygwin installation with a current version of GCC
208   and Mingw32. Each of the corresponding subdirectories contains a
209   shell script named "mkmf.sh" that takes "Makefile.win32.in" as its
210   input, appends the dependencies, and outputs "Makefile.win32". Then
211   simply say
212
213     make -f Makefile.win32 clean
214
215   to remove any compiled files or
216
217     make -f Makefile.win32 mclean
218
219   to remove any compiled files and the generated makefile. Say
220
221     make -f Makefile.win32
222
223   to compile the source code.
224
225   The GUI has to be compiled with Visual C++ 6. Simply open the
226   "Frontend.dsw" workspace in the Visual C++ 6 IDE. Then compile
227   "Frontend" and "Shim", which creates "Switch.exe" and
228   "Shim.exe". Copy these two executables into the same directory as
229   "olsrd.exe" and you are ready to go.
230
231 Well, thanks for using an early release of a piece of software and
232 please bear with me if there are any problems. Please do also feel
233 free to suggest any features that you'd like to see in future
234 releases.
235
236 Thomas Lopatic <thomas@lopatic.de>, 2004-09-15