Skip to content

Latest commit

 

History

History
executable file
·
81 lines (75 loc) · 6.78 KB

README_zh_CN.md

File metadata and controls

executable file
·
81 lines (75 loc) · 6.78 KB

English | 简体中文

XrayHelper

一个安卓专属的通用代理助手，使用 Golang 实现 Xray4Magisk 的部分脚本，提供 arm64 和 amd64 二进制文件

配置

XrayHelper 使用 yml 格式的配置文件，默认使用/data/adb/xray/xrayhelper.yml，当然你可以使用-c选项自定义配置文件路径
配置示例

  • xrayHelper
    • coreType默认值xray，指定所使用的核心类型，可选xray、v2ray、sing-box、mihomo、hysteria2
    • corePath必填，指定核心路径
    • coreConfig必填，指定核心配置文件，可指向文件或目录，影响核心的启动命令
    • dataDir必填，指定 XrayHelper 的数据目录，用于存储 GEO 数据文件、自定义节点和订阅节点信息等
    • runDir必填，用于存储运行时所产生的文件，例如核心的 pid 值，核心日志等
    • cpuLimit默认值100，用于限制模块服务的CPU（百分比），100 表示禁用限制
    • memLimit默认值-1，用于限制模块服务的内存（MB），-1 表示禁用限制
    • proxyTag默认值proxy，使用 XrayHelper 进行节点切换时，将进行替换的出站代理 Tag
    • allowInsecure默认值false，使用 XrayHelper 进行节点切换时，是否允许不安全的节点
    • subList可选，数组，节点订阅链接（SIP002/v2rayNg/Hysteria/Hysteria2），也支持 clash 订阅链接(需要在订阅链接前添加clash+前缀)
    • userAgent可选，自定义 XrayHelper http 请求的 User-Agent
  • clash
    • dnsPort使用mihomo时必填，默认值65533，mihomo 监听的 dns 端口, XrayHelper 会将本机 DNS 请求劫持到该端口
    • template可选，mihomo 配置模板，指定配置模板后，该模板会覆盖（或注入） mihomo 配置文件对应内容
  • adgHome
    • enable默认值false，是否随核心服务一同启动 AdGuardHome ，需要提前下载 adgHome 二进制文件（可使用命令xrayhelper update adghome），由于mihomo、hysteria2的 DNS 模块并不完善，仅建议与他们配合使用，其他核心直接使用核心 DNS 即可，使用不当可能导致 DNS 泄露
    • address启用时必填，默认值127.0.0.1:65530，AdGuardHome WebUI 监听地址
    • workDir启用时必填，AdGuardHome 的工作目录（该目录需包含配置文件config.yaml）
    • dnsPort启用时必填，AdGuardHome 监听的 DNS 端口；需要注意，由于hysteria2没有 DNS 模块，使用该核心时 XrayHelper 会将本机 DNS 请求劫持到该端口
  • proxy
    • method默认值tproxy，代理模式，可选tproxy、tun、tun2socks，使用 tun 模式时，请确保你的核心支持 tun 并正确配置它；使用 tun2socks 模式时，需要提前下载 tun2socks 二进制文件（可使用命令xrayhelper update tun2socks）
    • tproxyPort默认值65535，透明代理端口，该值需要与核心的 tproxy 入站代理端口相对应，tproxy模式需要
    • socksPort默认值65534，socks5 代理端口，该值需要与核心的 socks5 入站代理端口相对应，tun2socks模式需要
    • tunDevice默认值xtun，核心或 tun2socks 所创建的 tun 设备名
    • enableIPv6默认值false，是否启用 ipv6 代理，需要代理节点支持
    • autoDNSStrategy默认值true，是否自动配置核心的 DNS 策略（当未启用 IPv6 代理时，若禁用此特性，请确保你无法从核心的 DNS 解析到任何 AAAA 记录，否则可能导致域名代理策略失效问题）
    • mode默认值blacklist，代理应用名单模式，可选whitelist、blacklist，使用白名单模式时，下方应用名单内的应用流量会被标记，其他流量不会被标记（即绕过），反之，黑名单模式则不标记应用名单内的应用流量
    • pkgList，可选，数组，代理应用名单，格式为apk包名:用户，apk包名支持通配符（例如com.tencent.*）；未指定用户时，默认0，即机主；需要注意当该列表为空时，无论代理名单是什么模式，都会标记所有应用流量
    • apList，可选，数组，需代理的 ap 接口名，例如wlan+可代理 wlan 热点，rndis+可代理 usb 网络共享
    • ignoreList，可选，数组，需要忽略的接口名，例如wlan+可以实现连上 wifi 不走代理
    • intraList，可选，数组，CIDR，默认情况下，内网地址不会被标记，若需要将部分内网地址标记，可配置此项

命令

  • service
    • start启动核心服务
    • stop停止核心服务
    • restart重启核心服务
    • status检查核心服务状态
  • proxy
    • enable启用系统代理规则
    • disable停用系统代理规则
    • refresh刷新系统代理规则
  • update
    • core更新核心，需要指定 xrayHelper.coreType
    • adghome从 AdguardTeam/AdGuardHome 更新 adghome
    • tun2socks从 hev-socks5-tunnel 更新 tun2socks
    • geodata从 Loyalsoldier/v2ray-rules-dat 更新 GEO 数据文件
    • subscribe更新订阅节点（或 clash 订阅）到${xrayHelper.dataDir}/sub.txt（或${xrayHelper.dataDir}/clashSub#{index}.yaml），需要指定 xrayHelper.subList
    • yacd-meta更新 Yacd-meta 到${xrayHelper.dataDir}/Yacd-meta-gh-pages
    • metacubexd更新 metacubexd 到${xrayHelper.dataDir}/Yacd-meta-gh-pages

xray、sing-box、hysteria2

  • switch
    • 不带任何参数时，从订阅${xrayHelper.dataDir}/sub.txt获取节点信息并选择
    • custom从${xrayHelper.dataDir}/custom.txt获取节点信息并选择，因此，可将自定义节点的分享链接放置于此方便选择

mihomo

  • switch
    • 不带任何参数时，使用${xrayHelper.dataDir}/clashSub#{index}.yaml作为配置文件
    • example.yaml使用${xrayHelper.coreConfig}/example.yaml作为配置文件

注意：${clash.template} 总是会覆盖（或注入）你所使用的配置文件

许可

Mozilla Public License Version 2.0 (MPL)

鸣谢