12 KiB
Reticulum MeshChatX
English README | Deutsch | Italiano | Русский | 中文
Liam Cottle 氏による Reticulum MeshChat を大幅に改修・機能拡張したフォークです。
本プロジェクトはオリジナルの Reticulum MeshChat とは独立しており、提携関係にありません。
- ウェブサイト: meshchatx.com
- ソースコード: git.quad4.io/RNS-Things/MeshChatX
- 公式ミラー: github.com/Sudo-Ivan/MeshChatX — 現時点では Windows / macOS ビルドにも使用。
- リリース: git.quad4.io/RNS-Things/MeshChatX/releases
- 変更履歴:
CHANGELOG.md - TODO: Boards
Reticulum MeshChat からの主な変更
- LXST を使用
- Peewee ORM を生 SQL に置き換え
- Axios をネイティブ
fetchに置き換え - 最新の Electron
- Web サーバーと同梱フロントエンドを含む
.whlによりデプロイの選択肢を拡張 - i18n
- 依存関係管理に PNPM と Poetry
Warning
MeshChatX は旧バージョンの Reticulum MeshChat とのデータ互換性を保証しません。マイグレーションやテスト前にデータをバックアップしてください。
Warning
レガシーシステムはまだ完全にはサポートされていません。現在の最低要件: Python
>=3.11、Node>=24。
必要条件
- Python
>=3.11（pyproject.tomlより） - Node.js
>=24（package.jsonより） - pnpm
10.32.1（package.jsonより） - Poetry（
Taskfile.ymlおよび CI ワークフローで使用）
task install
task lint:all
task test:all
task build:all
インストール方法
環境とパッケージ形式に合わせて選んでください。
| 方法 | フロントエンド含む | アーキテクチャ | 最適な用途 |
|---|---|---|---|
| Docker イメージ | はい | linux/amd64, linux/arm64 |
Linux サーバーでの迅速なセットアップ |
Python wheel (.whl) |
はい | Python がサポートする全アーキテクチャ | Node ビルド不要のヘッドレス/Web サーバー |
| Linux AppImage | はい | x64, arm64 |
ポータブルデスクトップ |
Debian パッケージ (.deb) |
はい | x64, arm64 |
Debian/Ubuntu |
RPM パッケージ (.rpm) |
はい | CI 依存 | Fedora/RHEL/openSUSE |
| ソースから | ローカルビルド | ホストアーキテクチャ | 開発・カスタムビルド |
備考:
- リリースワークフローは Linux
x64およびarm64の AppImage + DEB を明示的にビルドします。 - RPM も試行され、成功時にアップロードされます。
クイックスタート: Docker
docker compose up -d
デフォルトの compose ファイル:
- ホスト
127.0.0.1:8000-> コンテナポート8000 ./meshchat-config->/config（永続化）
権限エラーが発生した場合:
sudo chown -R 1000:1000 ./meshchat-config
リリースアーティファクトからのインストール
1) Linux AppImage (x64/arm64)
- リリースから
ReticulumMeshChatX-v<バージョン>-linux-<アーキテクチャ>.AppImageをダウンロード。 - 実行権限を付与して起動:
chmod +x ./ReticulumMeshChatX-v*-linux-*.AppImage
./ReticulumMeshChatX-v*-linux-*.AppImage
2) Debian/Ubuntu .deb (x64/arm64)
ReticulumMeshChatX-v<バージョン>-linux-<アーキテクチャ>.debをダウンロード。- インストール:
sudo apt install ./ReticulumMeshChatX-v*-linux-*.deb
3) RPM ベースのシステム
- リリースに
ReticulumMeshChatX-v<バージョン>-linux-<アーキテクチャ>.rpmがある場合はダウンロード。 - インストール:
sudo rpm -Uvh ./ReticulumMeshChatX-v*-linux-*.rpm
4) Python wheel (.whl)
リリースの wheel にはビルド済みの Web アセットが含まれます。
pip install ./reticulum_meshchatx-*-py3-none-any.whl
meshchatx --headless
pipx もサポート:
pipx install ./reticulum_meshchatx-*-py3-none-any.whl
ソースからの実行（Web サーバーモード）
開発時やローカルのカスタムビルド向け。
git clone https://git.quad4.io/RNS-Things/MeshChatX.git
cd MeshChatX
corepack enable
pnpm install
pip install poetry
poetry install
pnpm run build-frontend
poetry run python -m meshchatx.meshchat --headless --host 127.0.0.1
サンドボックスで実行（Linux）
ネイティブの meshchatx（エイリアス: meshchat）をファイルシステムをより隔離した状態で動かすには、Reticulum と Web UI 向けの通常のネットワークアクセスを保ちつつ Firejail または Bubblewrap（bwrap）を使えます。詳しい例（pip/pipx、Poetry、USB シリアルの注意）は次を参照:
同梱または同期された meshchatx-docs から配信される場合、アプリ内の ドキュメント（MeshChatX ドキュメント）一覧にも同じページが表示されます。
ソースからのデスクトップパッケージビルド
スクリプトは package.json と Taskfile.yml に定義されています。
Linux x64 AppImage + DEB
pnpm run dist:linux-x64
Linux arm64 AppImage + DEB
pnpm run dist:linux-arm64
RPM
pnpm run dist:rpm
Task 経由:
task dist:fe:rpm
アーキテクチャサポート
- Docker:
amd64,arm64 - Linux AppImage:
x64,arm64 - Linux DEB:
x64,arm64 - Windows:
x64,arm64（ビルドスクリプトあり） - macOS: ローカルビルド向けにビルドスクリプトあり（
arm64,universal） - Android: リポジトリにプロジェクトと CI ワークフローあり
Android
設定
| 引数 | 環境変数 | デフォルト | 説明 |
|---|---|---|---|
--host |
MESHCHAT_HOST |
127.0.0.1 |
Web サーバーのバインドアドレス |
--port |
MESHCHAT_PORT |
8000 |
Web サーバーポート |
--no-https |
MESHCHAT_NO_HTTPS |
false |
HTTPS を無効化 |
--ssl-cert / --ssl-key |
MESHCHAT_SSL_CERT / MESHCHAT_SSL_KEY |
（なし） | PEM 証明書と鍵のパス。両方指定。アイデンティティの ssl/ 下の自動生成証明書を上書き。 |
--rns-log-level |
MESHCHAT_RNS_LOG_LEVEL |
（なし） | Reticulum（RNS）のログレベル（上記の名前または数値）。CLI は環境変数より優先。 |
--headless |
MESHCHAT_HEADLESS |
false |
ブラウザを自動で開かない |
--auth |
MESHCHAT_AUTH |
false |
基本認証を有効化 |
--storage-dir |
MESHCHAT_STORAGE_DIR |
./storage |
データディレクトリ |
--public-dir |
MESHCHAT_PUBLIC_DIR |
自動/同梱 | フロントエンドファイルディレクトリ（同梱資産のないインストール向け） |
ブランチ
| ブランチ | 目的 |
|---|---|
master |
安定版リリース。本番向けのコードのみ。 |
dev |
活発な開発。不安定または不完全な変更を含む場合があります。 |
開発
Taskfile.yml のよく使うタスク:
task install
task lint:all
task test:all
task build:all
Makefile のショートカット:
| コマンド | 説明 |
|---|---|
make install |
pnpm と poetry の依存関係をインストール |
make run |
poetry 経由で MeshChatX を実行 |
make build |
フロントエンドをビルド |
make lint |
eslint と ruff を実行 |
make test |
フロントエンドとバックエンドのテスト |
make clean |
ビルド成果物と node_modules を削除 |
バージョン管理
このリポジトリの現在のバージョンは 4.4.0 です。
- JavaScript / Electron のバージョンソースは
package.json。 meshchatx/src/version.pyは次でpackage.jsonと同期します:
pnpm run version:sync
リリースの一貫性のため、必要に応じて (package.json、pyproject.toml、meshchatx/__init__.py) のバージョンを揃えてください。
セキュリティ
SECURITY.md- アプリ実行時の組み込み整合性チェックとデフォルトの HTTPS/WSS
.gitea/workflows/の CI スキャンワークフロー
言語の追加
ロケールは自動検出されます。新しい言語には JSON ファイル 1 つで足ります:
en.jsonから空のテンプレートを生成:
python scripts/generate_locale_template.py
全キーを空文字にした locales.json が書き出されます。
- 名前を変更してロケールディレクトリへ移動:
mv locales.json meshchatx/src/frontend/locales/xx.json
-
ファイル先頭の
_languageNameにその言語の母語名を設定（例:"Espanol","Francais"）。言語選択に表示されます。 -
残りの値をすべて翻訳。
-
キーの整合性を確認:
pnpm test -- tests/frontend/i18n.test.js --run
他のコード変更は不要です。アプリ・言語選択・テストはビルド時に meshchatx/src/frontend/locales/ からロケールを読み込みます。
クレジット
- Liam Cottle - オリジナル Reticulum MeshChat
- RFnexus - Micron パーサー（JavaScript）
- markqvist - Reticulum, LXMF, LXST