HUB
Sign inSign up

lxy521031/wakebot-zh

By lxy521031

•Updated about 1 month ago

WakeBot 中文版:设备与 PS5 唤醒、四字菜单、私聊配置向导、Unraid 模板

Image
0

1.1K

lxy521031/wakebot-zh repository overview

⁠WakeBot 中文版:电脑 WoL 与 PS5 认证唤醒

镜像:lxy521031/wakebot-zh:1.3.0(linux/amd64)。通过 Telegram 唤醒电脑和 PS5,新增中文 PS5 配置向导、目录导入、多主机管理。镜像是通用程序,不包含发布者或其他用户的 PS5 配对信息。

⁠部署

services:
  wakebot:
    image: lxy521031/wakebot-zh:1.3.0
    network_mode: host
    restart: unless-stopped
    environment:
      TELEGRAM_TOKEN: "填写自己的机器人 Token"
      TELEGRAM_ADMIN: "填写自己的 Telegram 数字用户 ID"
      TELEGRAM_GROUP: "abc"
      TELEGRAM_THREAD: "1"
      LANGUAGE: "ZH"
      TZ: "Asia/Shanghai"
    volumes:
      - ./data:/app/data

TELEGRAM_ADMIN 多个管理员用英文逗号分隔;多个管理员需要按上游方式设置 TELEGRAM_GROUP。原有 Token、管理员、群组和线程设置继续有效。LANGUAGE 支持 ZH/EN/ES,PS5 配置向导当前使用中文。

容器使用 host 网络,并需能直接访问 PS5 的局域网 IPv4 / UDP 9302。数据目录必须可写。普通电脑用 /add 添加,/wake 选择唤醒,/remove 删除;已配置的 PS5 请用 /ps5 管理。

⁠方式一:Telegram 私聊配置向导

管理员私聊机器人发送 /ps5:

  1. 选择「添加主机」。
  2. 选择「导入文件」或「手填密钥」。
  3. 导出文件中有多台 PS5 时,选择自己的设备;手动方式需填写 MAC。
  4. 填写设备名称、PS5 局域网 IPv4,检查摘要。
  5. 点击「保存唤醒」。配置先保存,只有收到 PS5 的 Ready 回复才报告唤醒成功;测试失败保留已保存配置并提示错误。

文件名不限,最大 1 MiB。目前自动识别 Android Chiaki JSON 的 settings.registered_hosts 结构。不要求所有客户端都能导出 JSON;其他客户端可从已配对的本机配置中取得 Remote Play 注册密钥后手动填写。本版本不自动解析所有客户端格式,也不执行 PS5 的首次配对。

手动密钥支持 1–16 位十六进制 RegistKey(可带 0x)或 Chiaki rp_regist_key 的 Base64 值。它不是 PSN Account ID,不是 MAC,也不是 PS5 屏幕上的 8 位关联码。必须先在支持的 Remote Play 客户端中完成配对,再使用其实际保存的注册密钥;仅有 MAC 和 IP 无法认证唤醒。

再次 /ps5 可编辑名称/IP、更换密钥、测试唤醒、删除设备。删除需要二次确认,并同时移除本机凭据和对应设备列表条目。/cancel 随时取消;10 分钟无操作自动失效,旧按钮不能继续操作。不同管理员的会话相互隔离;他人更新配置后,过期的确认会被拒绝。

**隐私说明:**上传文件及手动输入密钥会经过 Telegram,机器人会尝试删除对应消息,但无法保证 Telegram 或客户端缓存彻底清除。原始上传只在内存处理,不写入磁盘,不记录密钥。希望配对信息不经过 Telegram 时,使用下面的本地目录方式。

⁠方式二:把文件放进容器的数据目录

所有文件放在映射到 /app/data 的宿主机目录,不是 Docker 的容器内部可写层。例如 Unraid 的 /mnt/pool/appdata/wakebot/;请以自己容器的实际映射为准。

启动后目录中会出现 ps5-import.json.example。复制为 ps5-import.json,将自己的已配对 Chiaki 导出文件也放在同一目录,修改示例:

{
  "version": 1,
  "imports": [
    {
      "source": "my-chiaki-export.json",
      "host": "192.168.1.50",
      "mac": "aa:bb:cc:dd:ee:ff",
      "name": "客厅 PS5"
    }
  ]
}

source 是相对于数据目录的文件名,不能指向目录外。host 必填;单个导出仅有一台 PS5 时可省略 mac;name 可省略,使用导出中的名称或默认名称。多台设备在 imports 中添加多个条目,导出可以来自同一个文件。

重启 WakeBot 后自动导入;输入内容未变化则跳过,启动时不自动唤醒。修改文件后重启可重新导入。每批配置全部验证成功才一起保存;解析失败保留原有 PS5 和普通 WoL 设备。原始导出文件和导入清单会保留,不自动删除。这些文件可能含密钥,请限制权限并妥善保管。目录导入和 TG 向导共用配置;若日后修改导入清单或原始导出,重新导入可能覆盖相同 MAC 的 TG 修改。

⁠命令行导入与测试

也可在数据目录已有导出文件时执行,无需固定文件名:

docker exec WakeBot python3 /app/ps5.py import-settings /app/data/my-chiaki-export.json --host 192.168.1.50 --mac aa:bb:cc:dd:ee:ff --name 客厅PS5
docker exec WakeBot python3 /app/ps5.py wake --mac aa:bb:cc:dd:ee:ff

导入支持多 PS5,单次命令选择一台。未指定名称时,命令行导入优先保留同 MAC 已有设备的名称。成功测试返回 PS5 ready 或 PS5 already_ready;失败仅返回固定错误码,不输出密钥。standby_not_verified 表示未确认目标处于待机,可能未响应、网络不可达或已关机;ready_timeout 表示发出认证唤醒后未在期限内确认 Ready。

⁠PS5 要求与数据安全

PS5 应启用远程游玩,并在待机设置中启用「保持与互联网连接」和「允许通过网络启动 PS5」。完全关机不能用此方法启动。PS5 使用 Remote Play 认证唤醒,普通 WoL 魔术包不能替代。配置 PS5 后,认证失败不会退回普通 WoL。

通过 Telegram 控制无需新增公网端口、域名或手机 IPv6。此镜像负责唤醒,不包含串流服务或 IPv6 串流转发,也不会修改路由器规则。

配置保存在 /app/data/ps5.json(权限 600),普通设备列表仍为 /app/data/devices。可用 PS5_CONFIG_FILE 指定其他持久化可写路径。多个写入操作共用文件锁,同时更新凭据和设备列表;写入失败回滚,中断时通过权限 600 的事务记录恢复。正常完成后移除该临时记录。

不要把 ps5.json、Chiaki 导出、Token 或真实设备信息打包到镜像、提交仓库或公开分享。每位使用者应配置自己的 Bot 和 PS5 配对凭据。拥有数据卷或备份读取权限的人可读取其中凭据,文件权限不能替代宿主机安全。

⁠升级、回滚与源码

从 1.1.0 / 1.2.0 升级无需重新配对,保留原 /app/data 映射和环境变量即可。升级前备份整个数据目录及原容器定义;如需回滚,将镜像改回 lxy521031/wakebot-zh:1.1.0,必要时恢复升级前数据。1.1.0 能读取当前 ps5.json 基本格式,但不提供新向导。

1.2.0 新增 TG 私聊配置、手动密钥、目录批量导入、过期按钮校验、配置冲突检测和可恢复的成对写入。1.3.0 统一四字中文菜单和按钮,补齐主菜单命令,增加可直接部署的 Unraid 模板;只提供基础运行环境变量,不增加高级开关。1.1.0 的 Ready 确认、认证唤醒和普通 WoL 兼容保留。不会自动删除历史备份或用户文件。

python3 -m unittest discover -s tests -v
docker build -t lxy521031/wakebot-zh:1.3.0 .

基于 dgongut/wakebot⁠ 的中文分支,保留 GPLv3 许可。上游说明见镜像内 /app/README.upstream.md,授权见 /app/LICENSE。实际 Python 源码、Dockerfile 和部署示例随镜像提供,可用 docker cp WakeBot:/app ./wakebot-source 提取;不要把运行中的 /app/data 作为公开源码分享。

⁠1.3.0 基础环境变量与 Unraid 模板

变量用途默认
TELEGRAM_TOKEN自己的机器人 Token,必填未配置则拒绝启动
TELEGRAM_ADMIN自己的数字用户 ID,必填未配置则拒绝启动
LANGUAGEZH / EN / ESZH
TZ日志时区UTC;示例/模板为 Asia/Shanghai
TELEGRAM_GROUP可选群组,单管理员私聊无需填写abc
TELEGRAM_THREAD可选话题1
PS5_CONFIG_FILE容器内部 PS5 配置路径/app/data/ps5.json

将镜像内 /app/unraid.xml 提取到 Unraid 启动盘的 /boot/config/plugins/dockerMan/templates-user/my-WakeBot.xml,然后在 Docker → 添加容器 → 用户模板选择 WakeBot。模板公开版不含个人凭据;填写自己的 Token、管理员 ID、时区和数据目录。群组、话题和配置文件路径在高级视图中。已有容器应先核对同名模板并保留数据,不能直接覆盖个人模板。

无需启动镜像即可提取文件:

docker create --name wakebot-template lxy521031/wakebot-zh:1.3.0
docker cp wakebot-template:/app/unraid.xml ./my-WakeBot.xml
# 提取完成后可移除这个从未启动的临时容器
docker rm wakebot-template

普通 Linux:复制 docker-compose.yml 和 .env.example,将后者改名为 .env 并填写自己的值,然后执行 docker compose up -d。保护 .env 和个人 Unraid XML;隐藏输入只隐藏界面显示,不代表配置已加密。

命令:/start 功能菜单、/wake 唤醒设备、/add 添加设备、/remove 删除设备、/ps5 主机设置、/cancel 取消设置、/version 版本信息、/donate 支持作者。

升级时建议固定版本标签;需要回退 1.2.0 时改回 lxy521031/wakebot-zh:1.2.0,保留同一数据目录。不要同时运行两个使用相同 Bot Token 的实例。Unraid 以后统一从模板编辑、应用,避免 CLI 重建后与模板不同步。

Tag summary

Content type

Image

Digest

sha256:bee5eb7a9…

Size

26.7 MB

Last updated

about 1 month ago

docker pull lxy521031/wakebot-zh