Skip to content
Snippets Groups Projects
Commit 5da5623b authored by Milan Pässler's avatar Milan Pässler
Browse files

rebranding

fix build
parent e80e8b2b
No related branches found
No related tags found
No related merge requests found
[![Build Status](https://travis-ci.org/tcatm/meshviewer.svg?branch=master)](https://travis-ci.org/tcatm/meshviewer) [![Build Status](https://travis-ci.org/plumpudding/hopglass.svg?branch=master)](https://travis-ci.org/plumpudding/hopglass)
# Meshviewer # HopGlass
Meshviewer is a frontend for HopGlass is a frontend for the [HopGlass Server](https://github.com/plumpudding/hopglass-server).
[ffmap-backend](https://github.com/ffnord/ffmap-backend).
[Changelog](CHANGELOG.md)
# Screenshots # Screenshots
...@@ -33,14 +29,14 @@ or if you have bundler you can install ruby-sass simply via `bundle install` ...@@ -33,14 +29,14 @@ 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: Execute these commands on your server as a normal user to prepare the dependencies:
git clone https://github.com/tcatm/meshviewer.git git clone https://github.com/plumpudding/hopglass
cd meshviewer cd hopglass
npm install npm install
npm install grunt-cli npm install grunt-cli
# Building # Building
Just run the following command from the meshviewer directory: Just run the following command from the hopglass directory:
node_modules/.bin/grunt node_modules/.bin/grunt
...@@ -52,11 +48,10 @@ Copy `config.json.example` to `build/config.json` and change it to match your co ...@@ -52,11 +48,10 @@ Copy `config.json.example` to `build/config.json` and change it to match your co
## dataPath (string) ## dataPath (string)
`dataPath` must point to a directory containing `nodes.json` and `graph.json` `dataPath` must point to the address of a [HopGlass Server](https://github.com/plumpudding/hopglass-server).
(both are generated by Don't forget the trailing slash!
[ffmap-backend](https://github.com/ffnord/ffmap-backend)). Don't forget the Also, proxying the data through a webserver will allow GZip and thus will greatly reduce bandwidth consumption.
trailing slash! Data may be served from a different domain with [CORS enabled]. It may help with firewall problems too.
Also, GZip will greatly reduce bandwidth consumption.
## siteName (string) ## siteName (string)
...@@ -99,19 +94,20 @@ you can use the case-sensitive template string `{NODE_ID}`. ...@@ -99,19 +94,20 @@ you can use the case-sensitive template string `{NODE_ID}`.
Examples for `nodeInfos`: Examples for `nodeInfos`:
"nodeInfos": [ "nodeInfos": [
{ "name": "Clientstatistik", { "name": "Clientstatistik",
"href": "nodes/{NODE_ID}.png", "href": "stats/dashboard/db/node-byid?var-nodeid={NODE_ID}",
"thumbnail": "nodes/{NODE_ID}.png", "thumbnail": "stats/render/dashboard-solo/db/node-byid?panelId=1&fullscreen&theme=light&width=600&height=300&var-nodeid={NODE_ID}"
"caption": "Knoten {NODE_ID}" "caption": "Knoten {NODE_ID}"
}, },
{ "name": "Uptime", { "name": "Uptime",
"href": "nodes_uptime/{NODE_ID}.png", "href": "stats/dashboard/db/node-byid?var-nodeid={NODE_ID}",
"thumbnail": "nodes_uptime/{NODE_ID}.png", "thumbnail": "stats/render/dashboard-solo/db/node-byid?panelId=2&fullscreen&theme=light&width=600&height=300&var-nodeid={NODE_ID}"
"caption": "Knoten {NODE_ID}" "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. In order to have statistics images available, you have to set up an instance of each [Prometheus](http://prometheus.io/) and [Grafana](http://grafana.org/).
## globalInfos (array, optional) ## globalInfos (array, optional)
...@@ -125,21 +121,12 @@ This option allows to show global statistics on statistics page depending on fol ...@@ -125,21 +121,12 @@ This option allows to show global statistics on statistics page depending on fol
In contrast to `nodeInfos` there is no template substitution in `href`, `thumbnail` or `caption`. In contrast to `nodeInfos` there is no template substitution in `href`, `thumbnail` or `caption`.
Examples for `globalInfos`: Examples for `globalInfos` using Grafana server rendering:
"globalInfos": [ "globalInfos": [
{ "name": "Wochenstatistik", { "name": "Wochenstatistik",
"href": "nodes/globalGraph.png", "href": "stats/render/render/dashboard-solo/db/global?panelId=1&fullscreen&theme=light&width=600&height=300",
"thumbnail": "nodes/globalGraph.png", "thumbnail": "nodes/globalGraph.png",
"caption": "Bild mit Wochenstatistik" "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.
[CORS enabled]: http://enable-cors.org/server.html
{ {
"name": "meshviewer", "name": "HopGlass",
"ignore": [ "ignore": [
"node_modules", "node_modules",
"bower_components", "bower_components",
...@@ -28,8 +28,9 @@ ...@@ -28,8 +28,9 @@
"jshashes": "~1.0.5" "jshashes": "~1.0.5"
}, },
"authors": [ "authors": [
"Milan Pässler <me@petabyteboy.de>",
"Nils Schneider <nils@nilsschneider.net>" "Nils Schneider <nils@nilsschneider.net>"
], ],
"license": "GPL3", "license": "AGPL3",
"private": true "private": true
} }
...@@ -3,13 +3,14 @@ define(function () { ...@@ -3,13 +3,14 @@ define(function () {
this.render = function (d) { this.render = function (d) {
var el = document.createElement("div") var el = document.createElement("div")
d.appendChild(el) d.appendChild(el)
var s = "<h2>Über meshviewer</h2>" var s = "<h2>Über HopGlass</h2>"
s += "<p>Mit Doppelklick und Shift+Doppelklick kann man in der Karte " s += "<p>Mit Doppelklick und Shift+Doppelklick kann man in der Karte "
s += "auch zoomen.</p>" s += "auch zoomen.</p>"
s += "<h3>AGPL 3</h3>" s += "<h3>AGPL 3</h3>"
s += "<p>Copyright (C) Milan Pässler</p>"
s += "<p>Copyright (C) Nils Schneider</p>" s += "<p>Copyright (C) Nils Schneider</p>"
s += "<p>This program is free software: you can redistribute it and/or " s += "<p>This program is free software: you can redistribute it and/or "
...@@ -27,9 +28,9 @@ define(function () { ...@@ -27,9 +28,9 @@ define(function () {
s += "<a href=\"https://www.gnu.org/licenses/\">" s += "<a href=\"https://www.gnu.org/licenses/\">"
s += "https://www.gnu.org/licenses/</a>.</p>" s += "https://www.gnu.org/licenses/</a>.</p>"
s += "<p>You may find the source code at " s += "<p>The source code is available at "
s += "<a href=\"https://github.com/ffnord/meshviewer\">" s += "<a href=\"https://github.com/plumpudding/hopglass\">"
s += "https://github.com/ffnord/meshviewer</a>." s += "https://github.com/plumpudding/hopglass</a>."
el.innerHTML = s el.innerHTML = s
} }
......
{ {
"name": "meshviewer", "name": "hopglass",
"scripts": { "scripts": {
"test": "node -e \"require('grunt').cli()\" '' clean lint" "test": "node -e \"require('grunt').cli()\" '' clean lint"
}, },
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment