Meshloom

Web interface for a MeshCore companion radio: messages, contacts, and mesh observation in the browser. The server talks to the radio over USB, TCP, or Bluetooth and keeps history beyond the device’s memory.

Fork of Jack Kingsman’s MeshCore web client, via Ian Langworth. Original copyright remains in LICENSE.md.

Trusted network only. There are no user accounts, and bots can run arbitrary Python. Optional HTTP Basic auth (MESHCORE_BASIC_AUTH_USERNAME / MESHCORE_BASIC_AUTH_PASSWORD) is a coarse gate and needs HTTPS. Set MESHCORE_DISABLE_BOTS=true to turn bots off.

Meshloom takes over radio contacts and channels. A poor fit if you swap radios and expect the device to keep its own favorites independently of the app.

Install

On Linux the installer offers a background service (a signed .deb or .rpm package where one exists for your machine, otherwise a source install; it refuses ARMv6 boards such as the Pi 1 and the original Pi Zero) or Docker. On macOS and other systems it offers Docker with a radio on the network, or simply points you to a Meshloom already running elsewhere. Radio transport is configured in the web UI after install. Use bash -c so prompts still have a terminal — do not pipe into bash.

/bin/bash -c "$(curl -fsSL https://get.meshloom.app)"

Then open http://127.0.0.1:8000 and choose the radio under Settings > Radio. Meshloom Community is optional and off on a new install: join it by entering an IATA code under Settings > Meshloom Community. User-facing docs live in docs/user/ and are published at https://meshloom.app/docs/.

A Raspberry Pi can skip the one-liner: flash meshloom-rpi-lite-arm64.img.xz from the release (Lite 64-bit, Pi 3 and later). The Release workflow builds that image after the arm64 .deb. Open the shipped meshloom.rpi-imager-manifest in Raspberry Pi Imager 2.0.6+ so Wi-Fi, user, and SSH are written (Use custom alone skips them). A connected screen shows http://meshloom.local:8000. Details: Raspberry Pi image.

From a checkout (development): CONTRIBUTING.md. Docker image: ghcr.io/twinrocket/meshloom. Portainer, HTTPS and systemd: README_ADVANCED.md. Environment variables: Variables and settings.

On Home Assistant

Meshloom runs as an add-on. The button opens the dialog on your own instance with the repository filled in — it is a redirector and learns nothing about you:

Or add https://github.com/TwinRocket/meshloom by hand under Settings → Add-ons → Add-on store → ⋮ → Repositories, then install Meshloom.

The web interface arrives in the sidebar; the radio proxy is the only thing published on the host. Options, the radio proxy port and reaching Meshloom from outside: meshloom/DOCS.md.

This is not the same as publishing to Home Assistant over MQTT, which works from any install and needs no add-on.

Update

On a package or installer-managed Docker install, Settings → Updates can install the new, signed Meshloom release (optional automatic updates). That upgrades Meshloom only.

Otherwise update by hand, or re-run the installer so it can install the apply helper if it is missing:

sudo apt-get install --only-upgrade meshloom   # Debian / Ubuntu (Meshloom only)
sudo dnf upgrade meshloom                      # Fedora / Rocky / Alma
sudo docker compose pull && sudo docker compose up -d

With Docker, pull only moves when the image reference does: if .env pins MESHLOOM_IMAGE to a version and digest, change it first (the digest of each release is in its signed OCI-DIGESTS asset).

Home Assistant: update the add-on there (the in-app updater only reports a new version). The database stays in place (/var/lib/meshloom for the package, ./data for Docker, the add-on's own config folder for Home Assistant). Schema migrations run on startup.

More

• User docs (source): docs/user/ — published at https://meshloom.app/docs/
• Security: report a vulnerability privately, see SECURITY.md
• API docs once the server is up: http://127.0.0.1:8000/docs
• Home Assistant — publishing the mesh over MQTT: README_HA.md
• Home Assistant — running Meshloom as an add-on: meshloom/DOCS.md