Installation

Requirements

  • Java JDK 1.5.0 (Java2) or better.
  • A few, rather common java libraries, which are provided in the svn version.

To make good use of freimap, you would need some data sources. Some of these are

  • Olsrd running with the dot_draw plugin, somewhere in the network.
  • A latlon.js file, generated by the nameservice plugin.
  • XML files containing node information, such as in certain freifunk maps. Some examples are provided in the data/ directory.
  • A database containing node information, topology data, or flow data, according to the provided SQL structures.

Getting

Download the latest precompiled build:

or get the sources using 'svn':

  • svn checkout http://relet.net/svn/freimap/trunk freimap
  • svn checkout https://relet.net/svn/freimap/trunk freimap (currently broken)

Compiling (svn only)

  • ./compile (or "compile.bat")

or, if ant is available:

  • ant

Running freimap

Configuration

This is probably the trickiest part of the process. The configuration for freimap is stored in the configuration file "config.yaml" in the YAML markup language. An example file is provided as "config.yaml.example". Read the Configuration Manual for more details on the available options.

The example config file will create two layers: A list of nodes read from the provided xml file, and one displaying topology information from an olsrd dot_info plugin listening on localhost:2004. This is probably the most common and easiest to provide set of data sources. Another simple option would be to get a latlon.js file generated by the nameservice plugin of your olsr daemon. There's an example in the configuration manual, too.

List of Data Sources

Please refer to the specific page for more details.

name type provides
OlsrdDataSource? live topology (links, LQ, NLQ)
LatLonJsDataSource? static coordinates, links
FreifunkMapDataSource? static coordinates
MysqlDataSource recorded coordinates, topology, other
FlowDataSource? recorded netflow traffic flows
SnmpDataSource? recorded SNMP node information
YamlDataSource? (defunct) live coordinates, topology, other

Running

  • ./run

or

  • java -Xmx500m -jar freimap.jar

If you have got less than 500mb free memory, you may want to adjust the -Xmx parameter. Freimap does not necessarily need that much unless you evaluate many months of collected data.

Using freimap

* User Guide

Troubleshooting

I will be compiling a FAQ with your questions and common misunderstandings.

* FAQ

Final words

Enjoy!

Comments and bug reports are welcome. Please use the ticketing system. If you'd like to contribute, contact me. If you send me an useful patch, I will give you access to the svn.