mirror of
https://github.com/ajvpot/meshexplorer.git
synced 2026-08-08 01:22:43 +02:00
Alex Vanderpot
1e456f04b8
Remove the snake_case mirror interfaces and mapper functions that translated generated protobuf-es messages for the components, and have the UI consume the generated types directly (single source of truth = the proto schema). - Hooks (useStats/useNeighbors/useNodeData/useMeshcoreSearch/useChatMessages) return generated message types; delete toNodeData/toChatMessage/toSearchResult and the snake_case select/.map adapters. Delete the dead useAllNeighbors hook and src/types/map.ts; components import NodePosition/Neighbor/NeighborEdge/ Advert/SearchResult/ChatMessage from src/gen. - Components read camelCase fields (node page, AdvertDetails, MapView, MapIcons, stats page, search results, chat). useNodeData surfaces ConnectError with a nodeErrorCode() helper for the error UI. Drop the always-empty Alt row in the map popup (generated NodePosition has no altitude). - buf lint (Option A): give each StatsService RPC its own request message, and wrap the server-streaming responses (StreamChatResponse / StreamPacketsResponse). Server stream handlers + the chat stream consumer updated accordingly. - Add a buf CI workflow (lint/format/breaking on proto changes). tsc, next build, and buf lint are clean; verified end-to-end in Docker. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
MeshExplorer
A real-time map, chat client, and packet-analysis tool for MeshCore mesh
networks. This repository ships the whole stack so it can be brought up with a
single docker compose up:
| Component | Path | Description |
|---|---|---|
| Web app | meshexplorer/ |
Next.js UI + API (map, chat, stats, packet analysis) |
| Ingest + DB | ingest/ |
Go MeshCore MQTT→ClickHouse ingest, ClickHouse image, and SQL migrations |
| Discord relay | meshexplorer/ (Dockerfile.bot) |
Optional bot that relays MeshCore channel messages to Discord |
| Grafana | grafana/ |
Dashboards with a pre-provisioned ClickHouse datasource (read-only user), on 127.0.0.1:3000 |
Architecture
MQTT brokers (you configure)
│
▼
┌──────────────┐ ┌──────────────┐
│ meshcoreingest│──▶│ ClickHouse │◀── migrate (one-shot, applies schema)
└──────────────┘ └──────┬───────┘
│ (readonly user)
┌──────────┴──────────┐
▼ ▼ ▼
meshexplorer discord-bot grafana
(web UI :3001) (--profile bot) (:3000)
Quick start
Requirements: Docker + Docker Compose.
cp .env.example .env
# Edit .env — at minimum set:
# CLICKHOUSE_PASSWORD (read/write user, used by ingest + migrations)
# MQTT_BROKERS (JSON array of meshcore MQTT brokers to ingest from)
# Optional, for the Discord relay: DISCORD_WEBHOOK_URL (+ run with --profile bot)
docker compose up --build
Then open http://localhost:3001.
Startup order is handled automatically: ClickHouse becomes healthy → migrate
applies the schema and exits → meshcoreingest and meshexplorer start.
To also run the Discord relay:
docker compose --profile bot up --build
Configuration
All configuration is via environment variables in .env (see
.env.example for the full list and defaults). Highlights:
- ClickHouse — two accounts. The read/write
defaultuser (CLICKHOUSE_PASSWORD) is used by the ingest daemon and the migration runner; thereadonlyuser (CLICKHOUSE_READONLY_PASSWORD) is used by the web app and the Discord bot. ClickHouse is only published to127.0.0.1for debugging and is otherwise reachable only on the internalmeshnetnetwork. - MQTT_BROKERS — a JSON array; each entry is
{ "url", "username", "password", "topics" }(topicsdefaults to["meshcore/#"]). The ingest daemon exits with a clear error if this is unset, so configure at least one broker.
Development
Each component can be run on its own:
- Web app: see
meshexplorer/README.md(npm install && npm run dev). - Ingest: see
ingest/README.md(go build ./...).
Security notes
.envis gitignored — keep real credentials out of version control.- If you previously used the bundled defaults, rotate any secrets before going to production.