Skip to content
pxhzaiiPublic

About

一款极简的网址导航工具,支持云端同步,后台缓存Favicon。

Resources

Stars

15 stars

Watchers

0 watching

Forks

Repository files navigation

NavSync

一款极简的网址导航工具,基于 COME COME 改进,支持云端同步,部署在 Cloudflare Pages,采用 favicon 代理 + KV 缓存 架构。

演示截图

功能

  • 个性主题切换(月白、初春、瀚海、大漠)
  • 网址自定义(鼠标拖动排序)
  • 搜索引擎自定义(百度、必应、谷歌、搜狗、维基百科)
  • 搜索词自动提示
  • 图标风格切换(鲜艳、朴素、灰白)
  • 色彩模式切换(系统自动、夜间模式、日间模式)
  • 导入、导出数据
  • 云端同步(基于 GitHub Gist + Cloudflare Pages Functions)
  • 访问口令保护(Token 存储在服务端环境变量中,前端不可见)
  • 暴力破解防护(5 次口令错误后锁定 15 分钟/约等于无)
  • 跨设备自动同步(换设备后自动查找云端已有配置,无需手动同步 ID)
  • Favicon 懒加载(图标异步加载、骨架占位、加载失败回退首字母彩色图标)
  • Favicon 代理 + KV 缓存(后端统一代理第三方图标源,KV 缓存 30 天,同一域名仅回源一次)

书签格式转换

仓库内的 换书签格式转换.html 文件 能将各种浏览器的书签转换为导航格式 下载文件后,浏览器打开就用 导出书签-转换导航格式-导入浏览器-上传云端 https://github.com/pxhzaii/NavSync/blob/main/%E4%B9%A6%E7%AD%BE%E6%A0%BC%E5%BC%8F%E8%BD%AC%E6%8D%A2.html

一键部署

前置条件

  • 一个 GitHub 账号
  • 一个 Cloudflare 账号(免费即可)

第一步:Fork 仓库

点击 GitHub 仓库右上角的 Fork 按钮,将项目复制到你的账号下。

仓库地址:pxhzaii/NavSync

第二步:获取 GitHub Token

GitHub Token 用于后端代你操作 Gist(创建、读取、更新)。仅需 gist 权限,不需要其他权限。

  1. 打开 GitHub Settings -> Developer settings -> Personal access tokens -> Tokens (classic)
  2. 点击 Generate new token (classic)
  3. 填写以下信息:
    • Note(备注):随便写,如 NavSync Cloud Sync
    • Expiration(有效期):按需选择
    • Scopes(权限):只勾选 gist,其他都不勾
  4. 点击页面底部的 Generate token
  5. 复制生成的 Token(格式类似 ghp_xxxxxxxxxxxx),页面关闭后无法再看到

也可以直接点击这个快捷链接,会自动帮你选好 gist 权限: 创建 Token(预设 gist 权限)

第三步:创建 KV 命名空间

favicon 缓存需要用到 Cloudflare KV,提前创建好,后续绑定时直接选用。

  1. 登录 Cloudflare Dashboard(右上角可切换语言)
  2. 左侧菜单进入 Workers 和 Pages(Workers & Pages)→ KV
  3. 点击 创建命名空间(Create namespace)
  4. 命名空间名称填 navsync-favicon(建议照填,方便后续对照;也可以取其他名字,不影响功能)

第四步:在 Cloudflare Pages 部署

以下路径按 Cloudflare 中文界面 写法,英文界面可对照括号里的英文。

  1. 回到 Workers 和 Pages,点击 创建应用程序(Create)→ 选择 Pages → 点击 连接到 Git(Connect to Git)

  2. 注意选的是 Pages,不是 Workers。页面底部有一行小字链接,点击可切换类型

  3. 授权 Cloudflare 访问你的 GitHub,选择你 Fork 的 NavSync 仓库

  4. 填写构建设置:

    • 框架预设(Framework preset):Vue
    • 构建命令(Build command):npm run build
    • 构建输出目录(Build output directory):dist
  5. 展开底部的 高级(Advanced)设置,配置以下变量。共 5 项,分两类:

    环境变量(Environment variables):

    变量名 必填 说明 示例值
    GITHUB_TOKEN 是 第二步获取的 GitHub Token,仅需 gist 权限 ghp_xxxxxxxxxxxx
    CLOUD_PASSWORD 否 访问口令,同步时需输入;留空则不启用口令保护 随机生成的复杂密码
    FAVICON_SOURCE 否 favicon 第三方图标源:google(默认)/ duckduckgo / 0x3 google
    FAVICON_TTL 否 favicon 缓存时长(秒),范围 60 ~ 2592000,默认 30 天 2592000

    KV 绑定(Bindings,不是环境变量):

    变量名(binding) 类型 必填 KV 命名空间 说明
    FAVICON_KV KV 命名空间 是 navsync-favicon(第三步创建的) favicon 代理缓存,变量名必须填 FAVICON_KV

    必填的只有两个:GITHUB_TOKEN(云端同步必需)和 FAVICON_KV(favicon 代理必需);其余三个可选,有默认值。

  6. 绑定 KV 命名空间(FAVICON_KV):

    • 在创建向导的 绑定(Bindings)区域点击 添加绑定(Add binding) (若创建时找不到该区域,部署完成后进入 设置 → 绑定,Settings → Bindings)
    • 类型(Type)选 KV 命名空间(KV namespace)
    • 变量名称(Variable name)填 FAVICON_KV(必须与上表一致)
    • KV 命名空间 选第三步创建的 navsync-favicon
    • 点保存
    • 若是在部署完成后再补绑定,保存后需到 部署(Deployments)页面点 重新部署(Redeploy)才会生效
  7. 点击 保存并部署(Save and Deploy)

第五步:等待部署完成

Cloudflare 会自动拉取代码、安装依赖、构建并部署。通常 2-3 分钟内完成。

部署成功后,你会得到一个 https://your-project.pages.dev 的地址。也可以在 Pages 项目的 自定义域(Custom domains)中绑定自己的域名。

第六步:开始使用

  1. 打开你的网站地址
  2. 进入设置 → 云端同步,点击「连接云端同步」
  3. 输入你设置的访问口令(CLOUD_PASSWORD),点击验证
  4. 验证通过后点击「上传到云端」即可同步配置
  5. 换设备时,重复上述步骤后点击「从云端拉取」,会自动查找并下载你之前上传的配置

如果未设置 CLOUD_PASSWORD 环境变量,则无需口令即可同步(不推荐,任何人都能操作)。 连续 5 次口令错误后,该 IP 将被锁定 15 分钟。

环境变量速查

部署步骤已包含完整配置。以下是常见疑问速查:

问题 回答
GITHUB_TOKEN 在哪设置? Pages 项目 → 设置 → 环境变量(Settings → Environment variables)→ 添加;或部署向导的 高级(Advanced)区域
CLOUD_PASSWORD 不设置会怎样? 不启用口令保护,任何人都能同步你的配置。建议设置
FAVICON_KV 为什么不在环境变量里? 它是 KV 命名空间绑定(KV namespace binding),需在 设置 → 绑定(Settings → Bindings)添加,属于另一类配置
KV 命名空间叫什么? 建议命名 navsync-favicon,也可以取其他名字,只要绑定时选对即可
绑定时变量名填什么? 必须填 FAVICON_KV,这是代码中读取的名称,不能改
补绑 KV 后不生效? 重新部署一次即可:部署 → 重新部署(Deployments → Redeploy)
FAVICON_SOURCE 能填什么? google(默认)/ duckduckgo / 0x3,三选一;不设置时默认 google
FAVICON_TTL 范围? 60 ~ 2592000 秒,超出会自动钳制到合法范围

致谢

About

一款极简的网址导航工具,支持云端同步,后台缓存Favicon。

Resources

Stars

15 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages