Download
Pick your system, download the build, and run it. Advanced installs are one click away if you need them.
Choose your platform
Tap the system you use. We show the recommended download first.
Windows 10 / 11
Download the installer, run it, and open MeshChatX from the Start menu. Use portable if you prefer no install.
64bit only
Linux
Most people want the AppImage. Download it, make it executable, and run it.
AppImage
A portable build with no package manager required. Download the architecture you need.
chmod +x MeshChatX-*.AppImage
./MeshChatX-*.AppImage
More install options
Debian (.deb)
Debian and Ubuntu packages for both AMD64 and ARM64.
sudo apt install ./MeshChatX-*.deb
# fallback if apt cannot resolve dependencies:
sudo dpkg -i MeshChatX-*.deb
sudo apt -f install
RPM (.rpm)
An RPM package for 64-bit x86 systems.
sudo dnf install ./MeshChatX-*.rpm
# or on openSUSE:
sudo zypper install ./MeshChatX-*.rpm
Alpine Linux (.apk)
apk-tools package for Alpine Linux on x86_64. This is not the Android APK.
sudo apk add --allow-untrusted ./ReticulumMeshChatX-*-linux-alpine-*.apk
Flatpak (.flatpak)
Single-file bundle for systems with Flatpak installed.
flatpak install ./MeshChatX-*.flatpak
Arch
Build and install manually using our PKGBUILD. This method handles dependencies and integrates with pacman.
git clone https://github.com/Quad4-Software/MeshChatX.git
cd MeshChatX/packaging/arch
makepkg -si
From Source
If you want to run MeshChatX from the source code locally:
git clone https://github.com/Quad4-Software/MeshChatX.git
cd MeshChatX
corepack enable
pnpm install
pnpm run build-frontend
pip install poetry
poetry install
poetry run meshchat --headless --host 127.0.0.1
Containers
Copy the Compose file if you run Docker or Podman day to day. Pull commands are under more options.
Compose
Standard docker-compose.yml for Compose-based installs.
services:
meshchatx:
image: quad4io/meshchatx:latest
# or ghcr.io/quad4-software/meshchatx:latest
ports:
- "8000:8000"
volumes:
- meshchatx-data:/root/.reticulum
volumes:
meshchatx-data:
More install options
Run using Docker. · AMD64 / ARM64
Same image from either registry. Use MESHCHAT_IMAGE in Compose to pick GHCR.
docker pull quad4io/meshchatx:latest
docker pull ghcr.io/quad4-software/meshchatx:latest
docker run -d --name reticulum-meshchatx \
--restart unless-stopped \
--security-opt no-new-privileges:true \
-p 127.0.0.1:8000:8000 \
-v meshchatx-config:/config \
quad4io/meshchatx:latest
Run using Podman. · AMD64 / ARM64
Same image from either registry. Use MESHCHAT_IMAGE in Compose to pick GHCR.
podman pull quad4io/meshchatx:latest
podman pull ghcr.io/quad4-software/meshchatx:latest
podman run -d --name reticulum-meshchatx \
--restart unless-stopped \
--security-opt no-new-privileges:true \
-p 127.0.0.1:8000:8000 \
-v meshchatx-config:/config \
quad4io/meshchatx:latest
Docker images are scanned using Trivy.
Python
Install from PyPI with pip. That is enough for most people.
pypi.org/project/reticulum-meshchatx
pip install reticulum-meshchatx
More install options
pipx install reticulum-meshchatx
poetry add reticulum-meshchatx
uv pip install reticulum-meshchatx
Run the meshchatx entry point from the package without a persistent install (uv tool run).
uvx --from reticulum-meshchatx meshchatx
Direct wheel URL
Pin the exact wheel file for this release from GitHub.
pip install https://github.com/Quad4-Software/MeshChatX/releases/download/v4.8.3/reticulum_meshchatx-4.8.3-py3-none-any.whl
pipx install https://github.com/Quad4-Software/MeshChatX/releases/download/v4.8.3/reticulum_meshchatx-4.8.3-py3-none-any.whl
poetry add https://github.com/Quad4-Software/MeshChatX/releases/download/v4.8.3/reticulum_meshchatx-4.8.3-py3-none-any.whl
uv pip install https://github.com/Quad4-Software/MeshChatX/releases/download/v4.8.3/reticulum_meshchatx-4.8.3-py3-none-any.whl
Android
Use the APK when it is available, or install via Termux for a headless node.
Universal APK
Termux
Install on Android via Termux. Install dependencies, then MeshChatX from PyPI. Run headless with meshchat --headless.
pkg upgrade
pkg install python
pkg install rust
pkg install binutils
pkg install build-essential
pip install reticulum-meshchatx
meshchat --headless