DDNS/schema/v2.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://ddns.newfuture.cc/schema/v2.json",
  "description": "DDNS 配置文件 https://github.com/NewFuture/DDNS",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string",
      "enum": [
        "https://ddns.newfuture.cc/schema/v2.json",
        "http://ddns.newfuture.cc/schema/v2.json",
        "./schema/v2.json"
      ],
      "default": "https://ddns.newfuture.cc/schema/v2.json"
    },
    "id": {
      "$id": "/properties/id",
      "type": "string",
      "title": "ID or Email",
      "description": "DNS服务API认证的ID或者邮箱",
      "default": ""
    },
    "token": {
      "$id": "/properties/token",
      "type": "string",
      "title": "API Token",
      "description": "DNS服务商的访问Token或者Key",
      "default": ""
    },
    "dns": {
      "$id": "/properties/dns",
      "type": "string",
      "title": "DNS Provider",
      "description": "dns服务商:阿里为alidns,DNS.COM为dnscom,DNSPOD国际版为dnspod_com,cloudflare",
      "default": "dnspod",
      "examples": ["dnspod", "alidns", "cloudflare"],
      "enum": ["dnspod", "alidns", "cloudflare", "dnspod_com", "dnscom"]
    },
    "ipv4": {
      "$id": "/properties/ipv4",
      "title": "IPv4 domain list",
      "description": "待更新的IPv4 域名列表",
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$id": "/properties/ipv4/items",
        "title": "ipv4 domain for DDNS",
        "type": "string",
        "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,18}$",
        "examples": ["newfuture.cc", "ipv4.example.newfuture.cc"]
      }
    },
    "ipv6": {
      "$id": "/properties/ipv6",
      "type": "array",
      "title": "IPv6 domain list",
      "description": "待更新的IPv6 域名列表",
      "uniqueItems": true,
      "items": {
        "$id": "/properties/ipv6/items",
        "title": "The ipv6 domain for DDNS",
        "type": "string",
        "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
        "examples": ["newfuture.cc", "ipv6.example.newfuture.cc"]
      }
    },
    "index4": {
      "$id": "/properties/index4",
      "type": ["string", "integer", "boolean"],
      "title": "IPv4 address Setting",
      "description": "本机 IPv4 获取方式\n`default`默认请求IP\n`public`公网\n数字表示网卡\n`url:http://myip.com`从URL的返回结果中提取\n`reg:xxx`正则提取IPconfig\n`cmd:xxx`或`shell:xx`命令行提取",
      "default": "default",
      "examples": [
        "default",
        "public",
        0,
        1,
        "regex:192\\\\.168\\\\..*",
        "url:https://ipinfo.io/ip",
        false
      ]
    },
    "index6": {
      "$id": "/properties/index6",
      "type": ["string", "integer", "boolean"],
      "title": "IPv6 address Setting",
      "description": "本机 IPv6 获取方式:`default`默认请求IP\n`public`公网\n数字表示网卡\n`url:http://myip.com`从URL的返回结果中提取\n`reg:xxx`正则提取IPconfig\n`cmd:xxx`或`shell:xx`命令行提取",
      "default": "default",
      "examples": [
        "default",
        "public",
        0,
        1,
        "regex:2404:f801:10:.*",
        "url:https://api6.ipify.org/",
        false
      ]
    },
    "proxy": {
      "$id": "/properties/proxy",
      "type": ["string", "null"],
      "title": "HTTP Proxy Setting",
      "description": "DIRECT表示直连,多个代理分号(;)分割,逐个尝试直到成功",
      "pattern": "^[a-zA-Z0-9\\-;_:\\.]*$",
      "examples": ["127.0.0.1:1080;DIRECT"],
      "default": "null"
    },
    "debug": {
      "$id": "/properties/debug",
      "type": "boolean",
      "title": "Enable Debug Mode",
      "description": "是否启用调试模式显示更多信息",
      "default": false,
      "examples": [false, true]
    },
    "cache": {
      "$id": "/properties/cache",
      "type": "boolean",
      "title": "Enable Cache",
      "description": "是否使用缓存",
      "default": true,
      "examples": [false, true]
    }
  },
  "required": ["id", "token"],
  "additionalProperties": false
}