Reticulum MeshChatX

Русский | Deutsch | Italiano | 中文 | 日本語

Project status

After the v5.0 release, MeshChatX will be in maintenance only mode for the next 12 months. End of life is the 1st of January 2028.

About

Initially MeshChatX was a fork of Reticulum MeshChat by Liam Cottle. It has evolved to be very much different and focused on modern software development principles. It may be buggy due to many changes and adapted to make it more maintainable and end goal of improving stability.

There are many changes from MeshChat: LXST, RRC relay chat, a dedicated Map that is offline ready, raw SQL instead of an ORM, native fetch instead of Axios, latest stable Electron, wheels with bundled frontend, i18n, pnpm 12+ with supply chain security.

MeshChatX is also focused on security and privacy, including usage of native OS sandboxing like AppContainer for windows and Landlock for linux.

AI Disclaimer: LLMs may be used to assist with development and maintaining the project, but all code is reviewed by humans and follows best practices.

• Website: meshchatx.com
• Source: github.com/Quad4-Software/MeshChatX
• Mirror: CodeFloe
• PyPI: reticulum-meshchatx
• Changelog: CHANGELOG.md
• LXMF: f489752fbef161c64d65e385a4e9fc74

rngit NomadNet Node: 132f67e79d9b24aad014e93015fb858f:/page/index.mu

Install/Usage Methods

There are many ways you can use MeshChatX.

Docker

docker compose -f docker/docker-compose.yml up -d

docker run -d --name reticulum-meshchatx \
  -p 127.0.0.1:8000:8000 \
  -v meshchatx-config:/config \
  ghcr.io/quad4-software/meshchatx:latest

Container Images: quad4io/meshchatx (Docker Hub) and ghcr.io/quad4-software/meshchatx. Hardened and extra tags are in Installation.

PyPI (pip, pipx, uv)

pip install reticulum-meshchatx
or
pipx install reticulum-meshchatx
or
uv pip install reticulum-meshchatx

meshchatx --headless --host 127.0.0.1

meshchat is the same entry point. Release wheels from GitHub also work: pip install ./reticulum_meshchatx-*-py3-none-any.whl.

From source (git clone, make, task)

HTTPS:

git clone https://github.com/Quad4-Software/MeshChatX.git
cd MeshChatX
Over Reticulum (rngit / git-remote-rns):
git clone rns://06a54b505bb67b25ef3f8097e8001edc/public/MeshChatX
cd MeshChatX

Then install and run with either Make or Task (same targets):

make install && make build && make run
or taskfile
task install && task build && task run
Or through UV / pnpm yourself:
corepack enable
pnpm install --frozen-lockfile
uv sync --group dev
pnpm run build-frontend
uv run python -m meshchatx.meshchat --headless --host 127.0.0.1

AppImage, deb, rpm, Flatpak, Electron, and Android: Installation and Building.

Docs

| Guide | Covers | | ----------------------------------------------------------- | -------------------------------------- | | Getting started | First-day flow | | Installation | Docker details, packages, CLI flags | | Building | Offline builds, packaging, Android APK | | Development | task/make, versioning, locales | | Identities and security | Backups, corruption recovery, wipe | | Platform guides | Pi, Termux, Quest, Linux sandbox |

Security, license, credits

• Project-owned code is 0BSD. Upstream MeshChat portions remain MIT. Full text: LICENSE.
• Credits: Liam Cottle (original MeshChat), RFnexus (micron parser JS), markqvist (Reticulum, LXMF, LXST).