From 7dc6089871e177f212b2f0ca2e3b1aea6b8264a2 Mon Sep 17 00:00:00 2001 From: NanamiAdmin Date: Mon, 28 Sep 2026 23:22:07 +0800 Subject: [PATCH] docs(readme): correct how system.networkProxy takes effect The rebuild only fires when the controllerMethod section changed, so editing networkProxy on its own does not rebuild anything and the channels keep the proxy they connected with. The previous wording read as though a rebuild would follow on its own. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b55ea3..4562b7b 100644 --- a/README.md +++ b/README.md @@ -303,7 +303,7 @@ Saving settings applies most of them immediately. How each group takes effect: | `controllerMethod` (all five channels) | Every channel is **rebuilt**: the running controllers are stopped and a fresh set is built from the new settings. A channel that owns a connection reconnects — Telegram re-runs its `getMe` handshake, NapCat opens a new WebSocket — so notifications sent during the swap are lost. The rebuild only happens when this section actually changed; saving a message template does not disturb the channels. | | `controllerMessage`, `debug`, `bot_user_config.json`, `bot_node_config.json`, `webhook.endpoints` | Picked up as they are used; nothing is restarted. | | `system.debugMode` | Applies to both behavior and log filtering. | -| `system.networkProxy` | Applies to connections opened afterwards. Channels that were built with `networkUseProxy` capture the proxy when they connect, so the address is only re-read on the next rebuild; the controller rebuild above does that. | +| `system.networkProxy` | Read when a channel builds its connection, so a channel only sees a new value once it is rebuilt. Changing this key **alone** does not trigger the rebuild above — change a `controllerMethod` value as well, or restart. | | `system.listenAddr` / `listenPort`, `webhook.enabled` / `listenAddr` / `listenPort`, `dataPath`, `dbPath`, `komari.dashboardURL` | **Applied at startup only.** Saving them changes the file and the in-memory configuration but not the running listener, database or Komari client — restart to apply. | ## API