跳到正文
NapCatQQ Desktop使用文档
维护与排错

备份、迁移与升级

导出配置、换机恢复、迁移数据目录和清理下载缓存,分清每种操作保留的内容。

数据 · 下载缓存

0 / 6演示说明

扫描与清理只作用于样例数据

先看清缓存内容,再选择清理

  1. 数据
  2. 范围
  3. 扫描
  4. 选择
  5. 清理
  6. 结果
未开始
数据 · 下载缓存界面预览
阅读位置开始阅读阅读进度 0%

配置调了一下午,终于一切正常,这时候最该做的一件事就是备份。准备升级或者换电脑之前,也记得先导出一份配置。如果只是系统盘快满了,那要用的是数据目录迁移。配置 ZIP 和数据迁移是两种不同的东西,下面会分开讲。

要做什么 入口
保存当前设置,或准备在另一台电脑重新搭建 「设置 → 数据 → 导出 ZIP」
从以前的配置包恢复 「设置 → 数据 → 打开导入向导」
把这台电脑的 Desktop 数据搬到另一块盘 「设置 → 数据 → 数据根目录 → 迁移」
清掉下载过的安装包,腾出空间 「设置 → 数据 → 下载缓存 → 扫描与清理」
更新 Desktop 「设置 → 关于 → 检查更新」,或安装新版 MSI

数据页提供配置备份、目录迁移与下载缓存清理入口。 · 演示数据

导出配置

  1. 先把 Bot、应用端和设置里刚改过的东西都保存好。导出的是已经保存的配置,没保存的草稿不会进去。
  2. 打开「设置 → 数据」。
  3. 在「配置备份」里点「导出 ZIP」。
  4. 存到一个你找得到的地方,文件名里加上日期,以后好分辨。
  5. 如果是准备换电脑,框架程序、插件、数据库和聊天消息这些要另外备份,并且记下原来用的是哪台主机、装在哪个路径。

ZIP 里有什么

内容 包含的范围
Desktop 与 Bot 外观、功能开关、运行与通知设置、Bot 连接配置
远端主机 服务器档案与连接参数
应用端实例 实例档案、Bot 关联、导入接管时保存的回滚快照
框架配置 Karin、NoneBot2、AstrBot、MaiBot、Koishi、云崽、NeoBot 的核心设置、模型与插件配置;麦麦自定义提示词及版本
聊天偏好 账号用途、后台接收、托盘通知、忽略与隐藏的群、界面布局
API 调试台 工作区、标签页草稿、布局、收藏与文件夹
SnowLuma 全局 WebUI 端口与密码覆盖设置
界面与终端 终端设置、常用命令、布局、Bot 手动排序、麦麦聊天昵称

下面这些不在 ZIP 里,需要另外保存:系统密钥库、SSH 私钥、组件和应用程序、插件程序、数据库、缓存、日志、API 调用历史和聊天消息记录。插件的配置能恢复回来,但插件程序本身还得重新装。

还有一点要注意:ZIP 里可能有敏感信息。框架配置原文里写着的 OneBot token、模型 API Key、通知凭据和密码,都会原封不动地存进去,所以别把配置包公开贴到 Issue 里。至于 SSH 密码、GitHub Token 这类存在系统密钥库里的凭据,不会进 ZIP,换电脑以后需要重新填。

恢复到当前电脑

最好是在刚装好 Desktop、还没启动任何实例的时候恢复。导入之前,Desktop 会先检查来源和目标,把要恢复的项目列给你看。

  1. 打开「设置 → 数据 → 打开导入向导」。
  2. 选一个配置 ZIP,或者直接把配置文件夹拖进向导。旧版的 ZIP 和以前那种扁平的配置文件夹也能用,新的配置包是 v2 格式。
  3. 看校验结果和要恢复的清单,确认这就是你想要的那一份。
  4. 确认导入。Desktop 会先把现有的配置备份一份再写入;来源校验没通过的话,什么都不会被覆盖,写入中途失败的话会自动回滚。
  5. 导入完成后重启一下 Desktop,让启动相关的设置生效。
  6. 逐个检查 Bot、远端主机和应用实例的路径和连接,确认没问题再启动。

配置包里没有的项目,会保持当前电脑上原来的配置不变。

换机后应用起不来

应用实例的档案里记录的是原来的主机和安装路径,新电脑上不一定有这个目录,也不一定装了对应的框架。所以换机以后,要这样恢复:

  1. 在目标主机上装好运行时、框架和插件程序。
  2. 核对实例指向的主机和安装路径,确认这个目录确实是对应框架的。
  3. 停止实例,再恢复框架配置。
  4. 检查模型、插件和 Bot 的关联,然后启动验证。

框架配置是按原文件恢复的,里面的注释、格式和自定义字段都会保留。数据库和历史记录,请用框架自己的备份方式来处理。

出现「待恢复」

框架配置待恢复

导入的时候,如果框架还没装、实例正在运行,或者远端暂时连不上,Desktop 会先把这部分配置存到数据目录里的待恢复副本中。看到这个提示时,不用再重新导入一遍 ZIP。

  1. 把对应的框架装好。
  2. 停止要恢复的应用实例。
  3. 远端实例要先恢复 SSH 连接。如果服务器的地址、端口或用户名变了,先去「远端」重新测试一下连接。
  4. 回到「设置 → 数据」,点「重试恢复框架配置」。
  5. 恢复完成以后,再启动实例。

恢复远端实例时,会重新核对一遍 SSH 的地址、端口和用户名,免得把配置写到旧主机上去。有待恢复配置的实例,启动时会提醒你先恢复。下次导出配置时,这些待恢复副本也会一起保存进去。

如果框架文件或者 Desktop 配置在写入时失败了,已经写进去的框架文件会一起回滚。万一因为远端断线导致回滚也失败了,就按界面上列出的文件逐个去检查。

界面偏好待恢复

有时候配置文件已经导入成功了,但界面或终端的偏好设置写入浏览器存储时失败了,数据页就会出现「重试恢复界面偏好」。把存储的问题解决以后,点它单独重试就行,不用再把整个配置导入一次。

把数据迁到另一块盘

默认的数据根目录是 %ProgramData%\NapCatQQ Desktop,实际位置以「设置 → 数据」里显示的为准。迁移会把配置、密钥、组件等数据整个复制过去,适合在同一台电脑上换一块盘。它和配置包不是一回事,迁移出来的数据不能直接拿到别的电脑上用。

  1. 在目标盘上新建一个空文件夹,比如 D:\NapCatData。你选的这个文件夹本身就是新的数据根目录,Desktop 不会再在里面多套一层产品名。
  2. 点「数据根目录」旁边的「迁移」。
  3. 点「选择目标文件夹」,选刚才建的那个空目录。
  4. 核对目标路径、预计要复制的大小,以及「将复制的结构」。有阻止原因的话,先按提示处理;本机正在运行的 Bot 会在迁移前被停掉。
  5. 点「开始迁移」,等它复制完。中途想反悔,可以点「取消复制」。
  6. 完成页会显示「新数据根」「旧数据根」以及可能出现的警告,核对一下。
  7. 旧目录可以先留着,等确认一切正常再说。如果想现在就删,必须在这个完成页上、重启之前点「删除旧目录」并确认,因为重启以后这个页面就没了。
  8. 按向导提示重启 Desktop,重启以后才会开始用新的数据根目录。最后到「设置 → 数据」确认一下新路径,再检查组件和 Bot 是否正常。

迁移不需要管理员权限,旧目录也只有在你确认以后才会被删除。如果目标目录不是空的,或者有其他阻止原因,换一个目录就好,不要去手动覆盖。远端 Windows 的代理和用户数据有它们自己的路径,不受本机数据根目录影响。

清理下载缓存

下载失败留下的旧安装包,还有更新了几次以后积攒下来的安装包,都可以在这里清掉。

  1. 等正在进行的安装、更新、迁移或者清理结束。
  2. 打开「设置 → 数据 → 下载缓存 → 扫描与清理」。
  3. 看看每个类别有多少文件、大概多大,以及会保留或跳过多少,勾选要清理的类别。
  4. 点「清理所选缓存」。
  5. 看一下删除了多少、跳过了多少、失败了多少。有没清理掉的,展开「查看未清理项目的原因」。想重新核对一遍,点「重新扫描」。

这里只会清理 Desktop 自己下载的安装包、旧的更新包和下载暂存文件。配置、迁移备份、安装日志、已经装好的组件、聊天记录、你另存的文件,以及 Windows Installer 的系统缓存,都不会被动。

最近 24 小时内的更新包会保留;系统临时目录里的历史下载,只会清理放了满 7 天、并且所属进程已经退出的那些。安装失败后留下的安装包,清掉以后下次重试就得重新下载了。

正在被占用、权限不够、只读或者是链接的文件,会被跳过并显示原因,其他符合条件的文件照常清理。清理过程不会提权,不会修改权限,也不会去掉只读属性。界面上显示的容量,是按文件大小估算出来的。

更新 Desktop

  1. 先导出一份配置。
  2. 在「设置 → 关于」点「检查更新」,按提示下载安装;也可以从 最新发布页 下载新版 MSI,直接覆盖安装。
  3. 更新完以后,检查一下版本号、Bot 和应用实例,再像往常一样启动。
  4. 如果你用了远端的 ncd-watch,记得去组件页单独检查一下它的版本。升级 Desktop 不会自动替换远端的 ncd-watch。

带 watch-v 的发布是远端值守组件,Desktop 安装包用的是 Desktop 自己的版本号。更新包下载失败的话,看 网络代理与下载线路;值守怎么维护,见 ncd-watch。

NapCatQQ Desktop · GPL-3.0下载 Windows 版 ↗

输入关键词,搜索全部教程与功能说明。

↑ ↓ 选择 · Enter 打开 · Esc 关闭本地全文搜索