nodeatlas

README

NodeAtlas

Federated node mapping for mesh networks

GPL 3+ Licensed, see LICENSE
© Alexander Bauer, Daniel Supernault, Dylan Whichard, Luke Evers, and contributors

NodeAtlas is a high-performance and very portable tool for geographically mapping mesh networks. It is used and designed by Project Meshnet.

It runs as a server which provides a web interface with two parts: a map, and an API. The mapping portion provides a comfortable and functional user interface using Bootstrap. The map itself is provided by Leafletjs, which loads tiles from OpenStreetMap (by default). Nodes are loaded by JQuery from the API.

The NodeAtlas itself is written in Go, and its API is powered by JAS, a RESTful JSON API framework.

In addition to the API, the Go backend provides a simple and powerful means of federation. Child maps are specified in the configuration, and NodeAtlas regularly queries their APIs, and pulls a list of node information, including nodes from sub-children, when are then displayed on the parent instance. This way, NodeAtlas is capable of acting as a regional map, incorporating nodes from multiple more localized instances. (More documentation on this behavior will be added in the future.)

Documentation

Overview

NodeAtlas - Federated mapping for mesh networks

Copyright (C) 2013 Alexander Bauer, Luke Evers, Daniel Supernault, Dylan Whichard, and contributors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/