https://github.com/freifunk/meshviewer
Visualization for Freifunk open mesh network nodes
https://github.com/freifunk/meshviewer
Last synced: 3 months ago
JSON representation
Visualization for Freifunk open mesh network nodes
- Host: GitHub
- URL: https://github.com/freifunk/meshviewer
- Owner: freifunk
- License: agpl-3.0
- Created: 2020-04-11T21:19:24.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-10-07T02:27:54.000Z (9 months ago)
- Last Synced: 2025-10-07T04:22:49.497Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.72 MB
- Stars: 12
- Watchers: 7
- Forks: 21
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Meshviewer
[](https://github.com/freifunk/meshviewer/actions?query=workflow%3A%22Build+Meshviewer%22)
[](https://github.com/freifunk/meshviewer/releases)
[](https://www.gnu.org/licenses/agpl-3.0)
Meshviewer is an online visualization app to represent nodes and links on a map for Freifunk open mesh network.
## Installation
It is recommended to use the latest release:
- Go to the [release page](https://github.com/freifunk/meshviewer/releases) and download the current build
- Let your webserver serve this build
- Add a config.json to the webdir (based on config.example.json)
## Docker Deployment
Using the GitHub Container Registry (GHCR) you can get the latest dockerized release with `docker compose`.
Put your config.json into the public folder and run the following to deploy a meshviewer:
```
docker compose pull
docker compose up -d
```
The map is reachable at [localhost:8080](http://localhost:8080).
Hint: Instead of the latest release `ghcr.io/freifunk/meshviewer:latest` one can also use version tags for a specific version or `main` for the latest unreleased commits.
## Configuration
The [configuration documentation](CONFIGURATION.md) is nowhere near finished. Please open a PR to add the missing pieces.
## Development & Building
To contribute to the project by developing new features, have a look at our [development documentation](DEVELOPMENT.md).
This also includes instructions on building this project.
## History
Meshviewer started as [ffnord/meshviewer](https://github.com/ffnord/meshviewer) for Freifunk Nord
which was extended as [hopglass/hopglass](https://github.com/hopglass/hopglass)
and further expanded by Freifunk Regensburg as [ffrgb/meshviewer](https://github.com/ffrgb/meshviewer).
After maintenance stopped, Freifunk Frankfurt took over expanding the code base as [freifunk-ffm/meshviewer](https://github.com/freifunk-ffm/meshviewer)
and added features like the deprecation warnings.
It is now maintained by the Freifunk Org at [freifunk/meshviewer](https://github.com/freifunk/meshviewer).
## Goals
The goal for this project is to extend Meshviewer, pick off where other forks ended
and integrate those ideas into a code-base that is easily usable by all Freifunk communities.
This also has the benefit that everyone can take advantage of the bundled development resources
for implementing new features and fixing bugs.