MeshChatX README

README проекта с github.com/Quad4-Software/MeshChatX. Одним файлом markdown: README.md.

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, Wails v3 desktop shell, 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.

Get it on Obtainium

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, desktop (Wails), 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

MeshChatX (Quad4-Software/MeshChatX)

Ищем в базе…

Что это такое?MeshChatX — это универсальный чат-клиент для ячеистой сети Reticulum. Изначально он был форком Reticulum MeshChat Лиама Коттла, но затем был значительно переписан ради большей стабильности, безопасности и удобства сопровождения.
Это приложение с графическим интерфейсом или инструмент командной строки?В первую очередь это настольное и мобильное приложение с графическим интерфейсом (сборки для настольных компьютеров на Electron и APK для Android). При этом есть флаги командной строки, а запускать его без интерфейса можно через Docker или PyPI для работы в режиме сервера.
Как установить и запустить его?Установить можно через PyPI (pip install reticulum-meshchatx, либо pipx или uv; точка входа meshchat), запустить образ Docker quad4io/meshchatx или ghcr.io/quad4-software/meshchatx, либо скачать пакеты для Linux (AppImage, deb, rpm, Flatpak) или APK для Android. Сборка из исходников выполняется через Make или Task.
Нужна ли мне существующая сеть Reticulum, чтобы пользоваться этим?Да, MeshChatX — это клиент поверх стека сетевых протоколов Reticulum (RNS/LXMF), поэтому для связи с другими узлами нужно настроить интерфейс или сеть Reticulum. Это не самостоятельный сервер чата.
Проект всё ещё активно разрабатывается?После выпуска v5.0 проект переходит в режим только поддержки на 12 месяцев, с объявленной датой окончания поддержки — 1 января 2028 года.
Старается ли он защитить мой трафик и систему от злоупотреблений?MeshChatX уделяет внимание безопасности и приватности, используя встроенные в систему средства изоляции: AppContainer в Windows и Landlock в Linux.
Можно ли пользоваться встроенной картой без подключения к интернету?Да, в MeshChatX есть отдельная функция «Карта», которая рассчитана на работу без интернета, в отличие от сервисов карт, зависящих от подключения к сети.
Можно ли запустить его на Raspberry Pi или на Android через Termux?Да, в документации есть отдельные руководства для платформ: Raspberry Pi, Termux, Meta Quest и настройка изоляции в Linux.
Какие есть похожие проекты?syncthing, bitchat, EnvoyMesh, nebula, partyline, EasyTier, gun, localsend
Автор
Quad4-Software
Размер
290.3 MB
Звёзды
171
Возраст
6 мес
Коммиты · 90 дней