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 网状网络的多合一聊天客户端。它最初分支自 Liam Cottle 的 Reticulum MeshChat,之后经过大幅重写,以提升稳定性、安全性和可维护性。
这是图形界面应用还是命令行工具?它主要是桌面和移动端的图形界面应用(包括 Electron 桌面版和 Android APK),同时也提供命令行参数,并可通过 Docker 或 PyPI 以无界面方式运行,适用于服务器场景。
怎样安装和运行?可以通过 PyPI 安装(pip install reticulum-meshchatx,也可用 pipx 或 uv,入口命令为 meshchat),运行 Docker 镜像(quad4io/meshchatx 或 ghcr.io/quad4-software/meshchatx),或者获取 Linux 安装包(AppImage、deb、rpm、Flatpak)或 Android APK;从源码构建则使用 Make 或 Task。
使用它之前,我需要已有的 Reticulum 网络吗?需要。MeshChatX 是运行在 Reticulum 网络协议栈(RNS/LXMF)之上的客户端,因此你需要配置好 Reticulum 接口或网络,才能真正连接到其他节点;它不是独立的聊天服务器。
这个项目还在积极开发吗?在 v5.0 发布之后,项目将进入为期 12 个月的仅维护模式,并已公布停止支持的日期为 2028 年 1 月 1 日。
它会保护我的网络流量和系统,防止被滥用吗?MeshChatX 注重安全与隐私,采用操作系统原生的沙箱机制,具体来说,在 Windows 上使用 AppContainer,在 Linux 上使用 Landlock。
没有互联网连接,我能使用内置的地图功能吗?可以。MeshChatX 包含一个专门的地图功能,其设计支持离线使用,不依赖联网的地图服务。
我能在树莓派上运行它,或者通过 Termux 在 Android 上运行吗?可以。文档中提供了专门的平台指南,涵盖树莓派、Termux、Meta Quest 以及 Linux 沙箱配置。
有哪些类似的项目?syncthing, bitchat, EnvoyMesh, nebula, partyline, EasyTier, gun, localsend
大小
290.3 MB
星标
171
时长
6个月
提交 · 90 天