Sign inSign up

cxzjoy/workbuddy2api

By cxzjoy

•Updated 8 days ago

Image
0

80

cxzjoy/workbuddy2api repository overview

⁠WorkBuddy2API 部署 Overview（Docker Compose）

镜像：cxzjoy/workbuddy2api:latest ｜ 平台：linux/amd64 ｜ 数据目录：/opt/workbuddy2api 以下命令从上到下整段执行即可，全部使用绝对路径。

⁠一、镜像信息

项目内容
镜像cxzjoy/workbuddy2api:latest（Alpine 3.20，39.5 MB）
端口7863 API 服务 ｜ 8787 GUI 管理界面
健康检查GET /healthz，每 30s 自检
运行用户app（uid 10001，非 root）
持久化/app/auths 账号凭证 ｜ /app/data 状态与登录凭据

⁠二、安装步骤

⁠1. 清理旧容器（首次安装可跳过）
docker rm -f workbuddy2api 2>/dev/null
⁠2. 建数据目录并修好属主

容器内用户是 uid 10001，这步不做 GUI 改口令会报 permission denied。

mkdir -p /opt/workbuddy2api/{auths,data}
chown -R 10001:10001 /opt/workbuddy2api
⁠3. 写 docker-compose.yml
cat > /opt/workbuddy2api/docker-compose.yml <<'EOF'
services:
  workbuddy2api:
    image: cxzjoy/workbuddy2api:latest
    container_name: workbuddy2api
    restart: unless-stopped
    network_mode: bridge
    environment:
      - TZ=Asia/Shanghai
    ports:
      - "7863:7863"   # API
      - "8787:8787"   # GUI 管理界面
    volumes:
      - /opt/workbuddy2api/auths:/app/auths   # 账号凭证
      - /opt/workbuddy2api/data:/app/data     # 运行状态/登录凭据
EOF
⁠4. （可选）迁移旧数据

如果之前把数据装在了 /root/auths、/root/data，先搬过来再启动。

cp -a /root/auths/.  /opt/workbuddy2api/auths/
cp -a /root/data/.   /opt/workbuddy2api/data/
chown -R 10001:10001 /opt/workbuddy2api
⁠5. 启动
cd /opt/workbuddy2api && docker compose up -d

⁠三、安装验证

docker compose ps                                # 状态应为 running (healthy)
docker logs --tail 50 workbuddy2api              # 看启动日志
curl http://127.0.0.1:7863/healthz               # API 健康检查

启动后浏览器访问：

  • GUI 管理界面：http://服务器IP:8787
  • API 服务：http://服务器IP:7863

⁠四、日常管理

操作命令（在 /opt/workbuddy2api 下执行）
启动 / 更新docker compose up -d
停止docker compose down
查看日志docker compose logs -f
升级镜像docker compose pull && docker compose up -d

⁠五、注意事项

  1. 绝对路径挂载：volumes 全部写的 /opt/workbuddy2api/...，在哪个目录执行 docker compose 都一样，不会落到 /root 下。
  2. 升级不丢数据：数据在宿主机 auths、data 目录里，删容器 / 升级镜像均不受影响。
  3. 默认 API Key 是 123456：公网部署前在 GUI 里修改口令（保存到 /opt/workbuddy2api/data/credentials.json），或挂载自定义 config.json。
  4. 仅 amd64 架构：ARM 服务器 / Apple Silicon 需加 --platform linux/amd64 走模拟，性能受影响。

Tag summary

Content type

Image

Digest

sha256:23515fe37…

Size

39.5 MB

Last updated

8 days ago

docker pull cxzjoy/workbuddy2api