From 121ae6036b7b1bacc0cd2289fea79fe59b35b9ee Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 20 Jan 2026 12:42:41 +0000 Subject: [PATCH] docs: add matrix crypto setup note --- docs/channels/matrix.md | 4 ++++ docs/plugins/manifest.md | 3 +++ 2 files changed, 7 insertions(+) diff --git a/docs/channels/matrix.md b/docs/channels/matrix.md index 6870eab41..cafdacdf1 100644 --- a/docs/channels/matrix.md +++ b/docs/channels/matrix.md @@ -117,6 +117,10 @@ Enable with `channels.matrix.encryption: true`: - Verify the device in another Matrix client (Element, etc.) to enable key sharing. - If the crypto module cannot be loaded, E2EE is disabled and encrypted rooms will not decrypt; Clawdbot logs a warning. +- If you see missing crypto module errors (for example, `@matrix-org/matrix-sdk-crypto-nodejs-*`), + allow build scripts for `@matrix-org/matrix-sdk-crypto-nodejs` and run + `pnpm rebuild @matrix-org/matrix-sdk-crypto-nodejs` or fetch the binary with + `node node_modules/@matrix-org/matrix-sdk-crypto-nodejs/download-lib.js`. Crypto state is stored per account + access token in `~/.clawdbot/matrix/accounts//__//crypto/` diff --git a/docs/plugins/manifest.md b/docs/plugins/manifest.md index 97ea69aa9..eb1f1f41e 100644 --- a/docs/plugins/manifest.md +++ b/docs/plugins/manifest.md @@ -61,3 +61,6 @@ Optional keys: - The manifest is **required for all plugins**, including local filesystem loads. - Runtime still loads the plugin module separately; the manifest is only for discovery + validation. +- If your plugin depends on native modules, document the build steps and any + package-manager allowlist requirements (for example, pnpm `allow-build-scripts` + + `pnpm rebuild `).