No Description

Nils Schneider fdb1b7b2fa filters: add (highly experimental) hostname filter 9 years ago
doc 9475306483 README: add screenshots 9 years ago
html 071cd3fe69 grunt: record git-revision in index.html 9 years ago
lib fdb1b7b2fa filters: add (highly experimental) hostname filter 9 years ago
scss fdb1b7b2fa filters: add (highly experimental) hostname filter 9 years ago
tasks 556a68e8fe Grunt should watch for changes in lib/infobox/*.js, too. 9 years ago
.gitignore c48f053619 move config.js from lib to root 9 years ago
.travis.yml 9e658e5f58 travis: config doesn't need to be present anymore 9 years ago
CHANGELOG.md 83b2a67cf4 Update changelog for v4 9 years ago
Gemfile 2e6b83aeef Since we have a ruby dependency, I added a Gemfile for bundler to properly handle ruby dependencies and further simplify the build process 9 years ago
Gemfile.lock 2e6b83aeef Since we have a ruby dependency, I added a Gemfile for bundler to properly handle ruby dependencies and further simplify the build process 9 years ago
Gruntfile.js dbccddbc22 The default grunt task now installs bower components, thus saving one step in the developer docs 9 years ago
LICENSE 2cbea6dc20 change LICENSE to AGPL 3 9 years ago
README.md fdf8188e3e Updated README.md with updated build instructions 9 years ago
app.js 102c8af873 move config.js to config.json, load by XHR 9 years ago
bower.json 008a1d0b0b use node_id hash to calculate startAngle for client layer 9 years ago
build.js 3a501766ff refactor main, app 9 years ago
config.json.example 102c8af873 move config.js to config.json, load by XHR 9 years ago
helper.js 9bdb7c562a helper/has_location: validate coordinates (+-90, +-180) 9 years ago
images 58cd7ad026 map: adding custom layers 9 years ago
index.html ff19d0cf8e sidebar styling 9 years ago
package.json dbccddbc22 The default grunt task now installs bower components, thus saving one step in the developer docs 9 years ago
style.css 3b5895601d switch to sass 9 years ago

README.md

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.