mirror/nanobot
1
0
Fork 0
mirror of https://github.com/HKUDS/nanobot.git synced 2026-08-11 06:48:39 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): document matrix e2eeEnabled option

Browse Source
This commit is contained in:
Alexander Minges
2026-02-10 17:51:28 +01:00
parent 0fff0488ab
commit f6f142bfb7
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -1
View File
@@ -287,6 +287,7 @@ Uses Matrix sync via `matrix-nio` (including inbound media support).
"userId": "@nanobot:matrix.org", "userId": "@nanobot:matrix.org",
"accessToken": "syt_xxx", "accessToken": "syt_xxx",
"deviceId": "NANOBOT01", "deviceId": "NANOBOT01",
"e2eeEnabled": true,
"allowFrom": [], "allowFrom": [],
"groupPolicy": "open", "groupPolicy": "open",
"groupAllowFrom": [], "groupAllowFrom": [],
@@ -301,6 +302,7 @@ Uses Matrix sync via `matrix-nio` (including inbound media support).
> `groupPolicy`: `open`, `mention`, or `allowlist`. > `groupPolicy`: `open`, `mention`, or `allowlist`.
> `groupAllowFrom`: Room allowlist used when `groupPolicy` is `allowlist`. > `groupAllowFrom`: Room allowlist used when `groupPolicy` is `allowlist`.
> `allowRoomMentions`: If `true`, accepts `@room` (`m.mentions.room`) in mention mode. > `allowRoomMentions`: If `true`, accepts `@room` (`m.mentions.room`) in mention mode.
> `e2eeEnabled`: Enables Matrix E2EE support (default `true`); set `false` only for plaintext-only setups.
> `maxInboundMediaBytes`: Max inbound attachment size in bytes (default `20MB`). > `maxInboundMediaBytes`: Max inbound attachment size in bytes (default `20MB`).
> [!NOTE] > [!NOTE]
@@ -308,7 +310,8 @@ Uses Matrix sync via `matrix-nio` (including inbound media support).
> >
> - Keep a persistent `matrix-store` and stable `deviceId`; otherwise encrypted session state can be lost after restart. > - Keep a persistent `matrix-store` and stable `deviceId`; otherwise encrypted session state can be lost after restart.
> - In newly joined encrypted rooms, initial messages may fail until Olm/Megolm sessions are established. > - In newly joined encrypted rooms, initial messages may fail until Olm/Megolm sessions are established.
> - The bot currently sends with `ignore_unverified_devices=true` (more compatible, less strict than verified-only sending). > - With `e2eeEnabled=false`, encrypted room messages may be undecryptable and E2EE send safeguards are not applied.
> - With `e2eeEnabled=true`, the bot sends with `ignore_unverified_devices=true` (more compatible, less strict than verified-only sending).
> - Changing `accessToken`/`deviceId` effectively creates a new device and may require session re-establishment. > - Changing `accessToken`/`deviceId` effectively creates a new device and may require session re-establishment.
**4. Run** **4. Run**