nemobb/singbox-config repository overview

defaults/     内置的默认节点配置与配置模版，属于程序的一部分
profiles/     节点配置，对应 ?profile= 参数
templates/    配置模版，对应 ?template= 参数

{
  "custom": {
    "name": "CustomName",
    "nodes": [
      "vless://uuid@host:port?encryption=none&flow=xtls-rprx-vision&security=tls&sni=sni&fp=chrome&type=tcp&headerType=none#Remark"
    ]
  },
  "subscriptions": [
    {
      "name": "GroupName",
      "url": "https://domain/path"
    }
  ]
}

curl "http://localhost:5300/api/singbox?profile=hello&singbox=1.14"

cp defaults/template-v114.json templates/mytpl.json

"outbounds": [
  { "type": "direct", "tag": "direct-out" },
  { "type": "selector", "tag": "GLOBAL", "outbounds": ["AUTO"], "default": "AUTO" },
  { "type": "urltest", "tag": "AUTO", "outbounds": [] }
]

template "mytpl.json" missing outbound tag: AUTO, node groups will not be injected

[
  { "type": "direct",   "tag": "direct-out" },
  { "type": "selector", "tag": "GLOBAL", "outbounds": ["AUTO", "我的机场"], "default": "AUTO" },
  { "type": "urltest",  "tag": "AUTO",   "outbounds": ["香港01", "日本01"] },
  { "type": "shadowsocks", "tag": "香港01" },
  { "type": "shadowsocks", "tag": "日本01" },
  { "type": "selector", "tag": "我的机场", "outbounds": ["香港01", "日本01"], "default": "香港01" }
]

sing-box check -c <生成的配置>

# 不挂载任何文件，通过 /api/singbox/sub 的请求参数传入订阅链接
docker run -d -p 5300:5300 nemobb/singbox-config:latest

# 挂载本地节点配置与模版，建议以只读方式挂载
docker run -d -p 5300:5300 \
  -v ~/singbox/profiles:/app/profiles:ro \
  -v ~/singbox/templates:/app/templates:ro \
  nemobb/singbox-config:latest

# 只挂载单个配置文件
docker run -d -p 5300:5300 \
  -v ~/hello.json:/app/profiles/hello.json:ro \
  nemobb/singbox-config:latest

# 通过 -e 传入环境变量，FETCH_TIMEOUT 单位是毫秒，20000 即 20 秒
docker run -d -p 5300:5300 \
  -v ~/singbox/profiles:/app/profiles:ro \
  -e TOKEN=your-secret \
  -e FETCH_TIMEOUT=20000 \
  nemobb/singbox-config:latest

services:
  singbox-config:
    image: nemobb/singbox-config:latest
    container_name: singbox-config
    restart: unless-stopped
    ports:
      - "5300:5300"
    volumes:
      - ./profiles:/app/profiles:ro
      - ./templates:/app/templates:ro
    environment:
      # 暴露到公网时务必设置
      - TOKEN=your-secret
      # 机场按 User-Agent 返回的不是分享链接时，改成机场支持的取值
      # - SUBSCRIPTION_USER_AGENT=v2rayNG/1.9.16
      # 仅在服务只对可信内网开放、且订阅托管在局域网时才开启
      # - ALLOW_PRIVATE_NETWORK=1

# 直接用订阅链接生成，无需任何配置文件
curl "http://localhost:5300/api/singbox/sub?name=MyAirport&url=https%3A%2F%2Fdomain%2Fpath&singbox=1.14"

# 使用 profiles/hello.json
curl "http://localhost:5300/api/singbox?profile=hello&singbox=1.14"

# 使用自定义模版
curl "http://localhost:5300/api/singbox?profile=hello&template=mytpl"

# 设置了 TOKEN 时
curl "http://localhost:5300/api/singbox?profile=hello&singbox=1.14&token=your-secret"

# docker compose
docker compose pull && docker compose up -d

# docker run
docker pull nemobb/singbox-config:latest
docker rm -f <容器名>   # 再用原来的参数重新 run

docker run -d -p 5300:5300 -e TOKEN=your-secret nemobb/singbox-config:latest
curl "http://localhost:5300/api/singbox?profile=hello&token=your-secret"