Sign inSign up

mayeee/homebox

By mayeee

•Updated 10 months ago

Image
0

2.1K

mayeee/homebox repository overview

⁠1. 镜像说明

一开始是作为 Lucky 中 STUN 的 WebHook 服务，当公网 ip/port 发生变化时，自动更新 SS 订阅(前提是已经在内网搭建了 SS 服务端)，方便客户端一键订阅，以实现在 NAT1 的网络环境下也能穿透内网，做到科学和回家同时使用，达到类似 Surge Ponte 的使用效果。由于搭建的是 SS 节点，全平台所有的客户端都支持这种协议。

⁠2. 已实现功能

当前已实现功能如下：

  1. STUN的WebHook(基础功能)，更新 SS 节点信息。
  2. Bark推送(附加功能)，提供单独接口用于推送任意消息，若配置则 WebHook也会推送 ip/port。
  3. 局域网唤醒WOL(附加功能)，实现对主机的管理：开机/关机/重启/休眠。IOS 可以用快捷指令、Android 可以用 MacroDroid 实现手机端管理。
  4. 节点订阅和文件服务器(基础功能)，用来获取订阅的 SS 节点。

基础功能：表示服务启动必有功能。 附加功能：表示功能可选，若未提供相关配置则不会启用。

⁠3. 部署方式

services:
  # UDP 广播不会穿透 Docker NAT 网络，即使用端口映射， 那也只影响接收，对容器发出的广播无作用。简单点这里还是用 host 模式
  homelan:
    image: mayeee/homebox:latest
    container_name: homebox
    network_mode: host
    environment:
      - TZ=Asia/Shanghai
      # 被唤醒设备 MAC
      - MAC="DD:B7:3C:88:00:c4" # 示例
      # 被唤醒设备内网 IP
      - IP="192.168.0.56" # 示例
      - PORT="22" # 默认值
      # 被唤醒设备用户名
      - USER="mayee" # 示例
      # 被唤醒设备密码
      - PASS="xxxxx"
      # 设备的 key, 用于 bark 通知
      - DEVICE_KEYS=["xxxxxxxxxx"]
      # aes 密钥, 必须 16 位
      - AES_KEY="xxxxxx"
      # aes 向量
      - AES_IV="xxxxxx"
    restart: unless-stopped
    volumes:
      - ./homebox:/app/ext

⁠4. 其他说明

部分功能详情可见：

⁠5. 更新说明

从 1.0.2 版本开始，不在需要挂载 sing-box 配置，但需要搭配 mayeee/shadowss 容器使用，并挂载上 shadowss 的环境变量。
从 1.0.1 版本开始，不再需要对端电脑上的休眠脚本，也不再需要 SSH 密钥。

Tag summary

Content type

Image

Digest

sha256:022dbb596…

Size

154.7 MB

Last updated

10 months ago

docker pull mayeee/homebox