Skip to content
This Fork is not maintained. Please use https://github.com/ffrgb/meshviewer
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc README: add screenshots Apr 1, 2015
html grunt: record git-revision in index.html Apr 19, 2015
lib legend: drop full stops and optically center circles vertically Sep 4, 2015
scss legend: drop full stops and optically center circles vertically Sep 4, 2015
tasks Grunt should watch for changes in lib/infobox/*.js, too. Sep 4, 2015
.gitignore move config.js from lib to root Apr 20, 2015
.travis.yml travis: config doesn't need to be present anymore Sep 4, 2015
CHANGELOG.md Update changelog for v4 Sep 4, 2015
Gemfile Since we have a ruby dependency, I added a Gemfile for bundler to pro… Sep 4, 2015
Gemfile.lock Since we have a ruby dependency, I added a Gemfile for bundler to pro… Sep 4, 2015
Gruntfile.js The default grunt task now installs bower components, thus saving one… Sep 4, 2015
LICENSE change LICENSE to AGPL 3 Apr 11, 2015
README.md Readme: hint to hopglass changed Jul 3, 2018
app.js move config.js to config.json, load by XHR Jul 27, 2015
bower.json use node_id hash to calculate startAngle for client layer Jun 2, 2015
build.js refactor main, app Mar 29, 2015
config.json.example move config.js to config.json, load by XHR Jul 27, 2015
helper.js helper/has_location: validate coordinates (+-90, +-180) Apr 10, 2015
images map: adding custom layers Apr 15, 2015
index.html sidebar styling Apr 4, 2015
package.json The default grunt task now installs bower components, thus saving one… Sep 4, 2015
style.css

README.md

This Fork is not maintained!

This was the original branch of the Meshviewer, but it is not further developed here. There are two main branches, that are worked on.

Please use https://github.com/ffrgb/meshviewer

If you are a developer, please consider joining this follow-up project or pickup on the also inactive project at https://github.com/hopglass/hopglass


Build Status

Meshviewer

Meshviewer is a frontend for ffmap-backend.

Changelog

Screenshots

Dependencies

  • npm
  • bower
  • grunt-cli
  • Sass (>= 3.2)

Installing dependencies

Install npm and Sass with your package-manager. On Debian-like systems run:

sudo apt-get install npm ruby-sass

or if you have bundler you can install ruby-sass simply via bundle install

Execute these commands on your server as a normal user to prepare the dependencies:

git clone https://github.com/tcatm/meshviewer.git
cd meshviewer
npm install
npm install grunt-cli

Building

Just run the following command from the meshviewer directory:

node_modules/.bin/grunt

This will generate build/ containing all required files.

Configure

Copy config.json.example to build/config.json and change it to match your community.

dataPath (string)

dataPath must point to a directory containing nodes.json and graph.json (both are generated by ffmap-backend). Don't forget the trailing slash! Data may be served from a different domain with CORS enabled. Also, GZip will greatly reduce bandwidth consumption.

siteName (string)

Change this to match your communities' name. It will be used in various places.

mapSigmaScale (float)

This affects the initial scale of the map. Greater values will show a larger area. Values like 1.0 and 0.5 might be good choices.

showContact (bool)

Setting this to false will hide contact information for nodes.

maxAge (integer)

Nodes being online for less than maxAge days are considered "new". Likewise, nodes being offline for less than than maxAge days are considered "lost".

mapLayers (List)

A list of objects describing map layers. Each object has at least name property and optionally url and config properties. If no url is supplied name is assumed to name a Leaflet-provider.

nodeInfos (array, optional)

This option allows to show client statistics depending on following case-sensitive parameters:

  • name caption of statistics segment in infobox
  • href absolute or relative URL to statistics image
  • thumbnail absolute or relative URL to thumbnail image, can be the same like href
  • caption is shown, if thumbnail is not present (no thumbnail in infobox)

To insert current node-id in either href, thumbnail or caption you can use the case-sensitive template string {NODE_ID}.

Examples for nodeInfos:

"nodeInfos": [
  { "name": "Clientstatistik",
    "href": "nodes/{NODE_ID}.png",
    "thumbnail": "nodes/{NODE_ID}.png",
    "caption": "Knoten {NODE_ID}"
  },
  { "name": "Uptime",
    "href": "nodes_uptime/{NODE_ID}.png",
    "thumbnail": "nodes_uptime/{NODE_ID}.png",
    "caption": "Knoten {NODE_ID}"
  }
]

In order to have statistics images available, you have to run the backend with parameter --with-rrd or generate them in other ways.

globalInfos (array, optional)

This option allows to show global statistics on statistics page depending on following case-sensitive parameters:

  • name caption of statistics segment in infobox
  • href absolute or relative URL to statistics image
  • thumbnail absolute or relative URL to thumbnail image, can be the same like href
  • caption is shown, if thumbnail is not present (no thumbnail in infobox)

In contrast to nodeInfos there is no template substitution in href, thumbnail or caption.

Examples for globalInfos:

"globalInfos": [
  { "name": "Wochenstatistik",
    "href": "nodes/globalGraph.png",
    "thumbnail": "nodes/globalGraph.png",
    "caption": "Bild mit Wochenstatistik"
  },
  { "name": "Jahresstatistik",
    "href": "nodes/globalGraph52.png",
    "thumbnail": "nodes/globalGraph52.png",
    "caption": "Bild mit Jahresstatistik"
  }
]

In order to have global statistics available, you have to run the backend with parameter --with-rrd (this only creates globalGraph.png) or generate them in other ways.

You can’t perform that action at this time.