nazhua/doc/public-note.md
2025-04-11 18:09:11 +08:00

3.1 KiB
Raw Blame History

📝 公开备注配置指南

🗺️ 点阵地图节点显示

地图说明

Nazhua采用的点阵地图是一个并非精准的变形地图不能使用真实经纬度坐标进行换算定位因此需要通过自定义坐标来指定位置。

配置方法

使用Nazhua配置生成器获取内置的点阵地图坐标或者自定义坐标(可以在config.js中配置customCodeMap添加自定义地图点)
在节点的公开备注对象中设置位置代码:

{
  "customData": {
    "location": "HKG"  // 位置代码
  }
}

默认位置映射

部分常见地区已有默认映射:

  • 中国大陆默认显示在北京v0.4.6后添加)
  • 美国默认显示在洛杉矶

🔧 customData 字段详解

可用字段

字段 用途 版本支持
location 指定节点地理位置代码 全版本
slogan 显示节点标语 全版本
orderLink 购买链接地址 全版本
flag 自定义国家/地区旗帜 v0.6.4+
buyBtnText 购买按钮文案 v0.5.3+
buyBtnIcon 购买按钮图标 v0.5.3+

示例配置

{
  "customData": {
    "location": "HKG",
    "slogan": "这是一个香港节点",
    "orderLink": "https://buy.example.com",
    "buyBtnText": "官网",
    "buyBtnIcon": "ri-gift-2-line",
    "flag": "cn"
  }
}

💡 链接编码提示

由于配置数据无法正常解析符号&请使用URL编码

📊 原版公开备注支持

在哪吒的主题ServerStatus迭代中nap0o增加了一个公开备注的功能可以给节点添加额外的展示信息
具体字段定义参考 https://github.com/nezhahq/nezha/pull/425
Nazhua支持原版ServerStatus主题的公开备注字段支持的字段如下

账单信息 (billingDataMod)

{
  "billingDataMod": {
    "startDate": "2024-10-01T00:00:00+08:00",
    "endDate": "2024-11-01T00:00:00+08:00",
    "autoRenewal": "1",
    "cycle": "月",
    "amount": "$3.99"
  }
}

配置信息 (planDataMod)

{
  "planDataMod": {
    "bandwidth": "30Mbps",
    "trafficVol": "1TB/月",
    "trafficType": "1",
    "IPv4": "1",
    "IPv6": "1",
    "networkRoute": "CN2,GIA",
    "extra": "传家宝,AS9929"
  }
}

🔍 完整公开备注示例

{
  "billingDataMod": {
    "startDate": "2024-10-01",
    "endDate": "2024-11-01",
    "autoRenewal": "1",
    "cycle": "月",
    "amount": "$3.99"
  },
  "planDataMod": {
    "bandwidth": "30Mbps",
    "trafficVol": "1TB/月",
    "trafficType": "1",
    "IPv4": "1",
    "IPv6": "1",
    "networkRoute": "CN2,GIA",
    "extra": "传家宝,AS9929"
  },
  "customData": {
    "location": "HKG",
    "slogan": "这是一个香港节点",
    "orderLink": "https://buy.example.com",
    "buyBtnText": "官网",
    "buyBtnIcon": "ri-gift-2-line",
    "flag": "cn"
  }
}