Keine Beschreibung

kokel ae931347be meshstats: count and show all nodes (online and offline)		vor 9 Jahren
doc	9475306483 README: add screenshots	vor 9 Jahren
html	071cd3fe69 grunt: record git-revision in index.html	vor 9 Jahren
img	ca3dd9ae29 forcegraph: optimize background image	vor 9 Jahren
lib	ae931347be meshstats: count and show all nodes (online and offline)	vor 9 Jahren
scss	773cbe8b9c infobox: fix line-wrapping of client list	vor 9 Jahren
tasks	071cd3fe69 grunt: record git-revision in index.html	vor 9 Jahren
.gitignore	c48f053619 move config.js from lib to root	vor 9 Jahren
.travis.yml	ad0bd8182d travis: use config.js.example for CI	vor 9 Jahren
CHANGELOG.md	70d78e3742 forcegraph: backport client circles from ffmap-d3	vor 9 Jahren
Gruntfile.js	071cd3fe69 grunt: record git-revision in index.html	vor 9 Jahren
LICENSE	2cbea6dc20 change LICENSE to AGPL 3	vor 9 Jahren
README.md	32a2bc8540 readme: remove nodeInfo parameter type from documentation	vor 9 Jahren
app.js	22b49c1a55 map: draw only labels present on map using rtrees	vor 9 Jahren
bower.json	22b49c1a55 map: draw only labels present on map using rtrees	vor 9 Jahren
build.js	3a501766ff refactor main, app	vor 9 Jahren
config.js.example	115444f1cb config: introduce maxAge setting	vor 9 Jahren
helper.js	9bdb7c562a helper/has_location: validate coordinates (+-90, +-180)	vor 9 Jahren
images	58cd7ad026 map: adding custom layers	vor 9 Jahren
index.html	ff19d0cf8e sidebar styling	vor 9 Jahren
package.json	071cd3fe69 grunt: record git-revision in index.html	vor 9 Jahren
style.css	3b5895601d switch to sass	vor 9 Jahren

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

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 bower grunt-cli
node_modules/.bin/bower install

Configure

Copy config.js.example to config.js 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".

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.

Building

Just run the following command from the meshviewer directory:

node_modules/.bin/grunt

This will generate build/ containing all required files.

README.md