Skip to content

这一组配置控制什么

编辑器里的「静态更新配置(update)」分组,控制的是客户端里的「检查更新」弹窗。这些字段最终会写入客户端的 OSS 配置文件,作为其中的 update 段;客户端解析该段后执行更新检测:是否需要提示更新、提示里写什么、以及点击更新后跳到哪个下载地址。

这组配置默认关闭。只有打开「启用静态更新配置」后,update 段才会写进 OSS 配置文件,下面的版本号、下载地址和更新说明才会真正参与生成。

提示

启用后生成的配置兼容所有版本的客户端:旧版客户端会跳过 update 字段,不影响站点地址等其它字段的读取;新版客户端才会解析并执行更新检测。

注意

「检查更新」只负责通知用户并提供下载入口,不会把新版本安装到客户端上。真正的安装包仍然要在「软件打包」里产出,具体操作见软件打包

下载地址的键名映射

OSS 配置文件update.download_urls 是一个按平台分键的对象,编辑器里每个平台的输入框对应其中一项:

平台下载地址
Android✅ 可填
Windows✅ 可填
Linux ARM64✅ 可填
Linux AMD64✅ 可填
macOS Apple Silicon✅ 可填
macOS Intel✅ 可填

下载地址的优先级与导入规则

自动更新地址优先于手动更新地址

  • 客户端优先使用自动更新下载地址,也就是 download_urls 里与当前平台和架构匹配的那一项。
  • 手动更新地址manual_download_url)是另一种入口:支持填写网盘页、官网发布页等手动下载跳转地址,供自动更新地址之外的场景使用。
  • 启用这组配置时,「最新版本(latest_version)」为必填;并且至少要填写一个自动更新下载地址,或者提供一个手动更新地址,否则保存校验不通过。
  • 没有填写的下载地址会被直接省略,不会在 download_urls 里留下空值。

Linux 与 macOS 已按架构拆分

静态配置里的 Linux 与 macOS 自动更新地址已经按 CPU 架构拆分,这两个平台各有两个输入框(ARM64 与 AMD64)。

导入旧版配置时不需要手工拆分:旧写法中的 download_urls.linuxdownload_urls.macos 会自动回填到该平台对应的架构输入框。

提示

旧字段只有一个值时,会被同时回填到该平台的两个架构输入框里,记得按实际产物把用不到的那一个改掉或清空。

强制标记与强制更新的区别

这两个字段都是下拉选择,取值都是 truefalse,但作用完全不同,不要混用:

管什么设为 true设为 false
是否强制标记为「有更新」客户端会直接提示更新,不再依赖版本比较客户端仍会继续比较版本号,由版本差异决定是否提示
提示出现后能否跳过用户只能立即更新,不能关闭弹窗用户可以关闭弹窗,稍后再更新

重要

「强制更新」只控制弹窗能不能被关闭;是否需要弹出更新提示,取决于「强制标记」与版本号比较的结果。所以排查「设置不生效」时,先确认提示有没有真的弹出来,再检查这个开关。

配置项

启用静态更新配置

  • 控件:开关

这一组配置的总开关,默认关闭。开启后才会把静态更新配置写入 OSS 配置文件,并展开下面的版本、下载地址与更新说明表单;关闭时整段 update 配置都不会写入。

配置说明(description)

  • 控件:文本框
  • 示例:静态更新配置

update 段的说明文字,用于说明这份静态更新配置本身。

最新版本(latest_version)

  • 控件:文本框
  • 示例:1.0.1

供客户端比较的版本号。当「强制标记」为 false 时,客户端会比较这个版本号,并据此决定是否提示更新。启用静态更新配置后,本项为必填。

Android 下载地址

Android 平台的自动更新下载地址,写入 download_urls.android

Windows 下载地址

Windows 平台的自动更新下载地址,写入 download_urls.windows

Linux ARM64 下载地址

Linux ARM64 平台的自动更新下载地址,写入 download_urls[linux-arm64]

Linux AMD64 下载地址

Linux AMD64 平台的自动更新下载地址,写入 download_urls[linux-amd64]

macOS Apple Silicon 下载地址

macOS Apple Silicon(ARM64)平台的自动更新下载地址,写入 download_urls[macos-arm64]

macOS Intel 下载地址

macOS Intel(AMD64)平台的自动更新下载地址,写入 download_urls[macos-amd64]

手动更新地址

手动下载的跳转地址,支持填写网盘页、官网发布页等页面。客户端会优先使用自动更新下载地址,本项作为手动下载的入口。

强制标记(update_available)

  • 控件:下拉选择
  • 取值范围true / false

设为 true 时客户端会直接提示更新;设为 false 时仍会继续比较版本号。

强制更新(force_update)

  • 控件:下拉选择
  • 取值范围true / false

设为 true 时客户端只能立即更新,不能关闭弹窗。

注意

这个开关会直接影响用户体验,建议只在必须拦截的版本上临时开启,推送完成后尽快改回 false

更新说明(release_notes)

  • 控件:多行文本

本次更新的说明文案,写入 update 段的 release_notes,用于向用户描述这次更新包含哪些内容。

相关页面

本文档依据 Xboard-Mihomo-builds 源码整理