Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

add openclaw-plugin upgrade description (#758)

AutoCoder51d0be0e987e
diff --git a/examples/openclaw-plugin/INSTALL-ZH.md b/examples/openclaw-plugin/INSTALL-ZH.md
index b494faac1..edd50745b 100644
--- a/examples/openclaw-plugin/INSTALL-ZH.md
+++ b/examples/openclaw-plugin/INSTALL-ZH.md
@@ -26,6 +26,33 @@
**前置条件:** Python >= 3.10,Node.js >= 22。安装助手会自动检查并提示安装缺少的组件。
+### 从旧版 `memory-openviking` 升级到新版 `openviking` 前置操作步骤
+
+如果当前环境里已经安装过旧版插件 `memory-openviking`,建议先完成以下前置操作,再执行新版安装,避免旧版和新版插件同时存在。
+
+1. 停止 OpenClaw gateway:
+
+```bash
+openclaw gateway stop
+```
+
+2. 备份旧版本配置和插件目录:
+
+```bash
+cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.pre-openviking-upgrade.bak
+mkdir -p ~/.openclaw/disabled-extensions && mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memory-openviking-upgrade-backup
+```
+
+3. 修改 OpenClaw 配置,移除旧版本配置参数:
+
+编辑 `~/.openclaw/openclaw.json`,删除 `plugins.allow` 中的 `"memory-openviking"`,删除 `plugins.entries.memory-openviking`,并将 `plugins.slots.memory` 改为 `"none"`。
+
+4. 保留并迁移旧版本运行参数到新版本配置:
+
+如果旧版本原来使用的是 `plugins.entries.memory-openviking.config`,请将其中的 `mode`、`configPath`、`port`、`baseUrl`、`apiKey`、`agentId` 按需迁移到新版 `plugins.entries.openviking.config`。
+
+完成以上前置操作后,再按下方任一方式安装新版插件。
+
### 方式 A:npm 安装(推荐,全平台)
```bash
diff --git a/examples/openclaw-plugin/INSTALL.md b/examples/openclaw-plugin/INSTALL.md
index 9f1f52609..0f840826e 100644
--- a/examples/openclaw-plugin/INSTALL.md
+++ b/examples/openclaw-plugin/INSTALL.md
@@ -28,6 +28,33 @@ Provide long-term memory capabilities for [OpenClaw](https://github.com/openclaw
**Prerequisites:** Python >= 3.10, Node.js >= 22. The setup helper will automatically check and prompt you to install any missing components.
+### Prerequisite Steps for Upgrading from Legacy `memory-openviking` to New `openviking`
+
+If the current environment already has the legacy `memory-openviking` plugin installed, complete the following prerequisite steps before installing the new version to avoid having both plugins active at the same time.
+
+1. Stop the OpenClaw gateway:
+
+```bash
+openclaw gateway stop
+```
+
+2. Back up the legacy configuration and plugin directory:
+
+```bash
+cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.pre-openviking-upgrade.bak
+mkdir -p ~/.openclaw/disabled-extensions && mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memory-openviking-upgrade-backup
+```
+
+3. Update the OpenClaw configuration and remove legacy settings:
+
+Edit `~/.openclaw/openclaw.json`, remove `"memory-openviking"` from `plugins.allow`, remove `plugins.entries.memory-openviking`, and change `plugins.slots.memory` to `"none"`.
+
+4. Preserve and migrate legacy runtime settings into the new configuration:
+
+If the legacy plugin was using `plugins.entries.memory-openviking.config`, migrate `mode`, `configPath`, `port`, `baseUrl`, `apiKey`, and `agentId` into `plugins.entries.openviking.config` as needed.
+
+After completing the prerequisite steps above, install the new plugin using either method below.
+
### Method A: npm Installation (Recommended, Cross-platform)
```bash