Add Docker Compose one-click deployment

README.md

@@ -1,41 +1,96 @@
 # douyin-sparkflow
 
-这个仓库是一个围绕 `DouYinSparkFlow/` 组织的部署仓库，用于保存核心应用源码、代理配置和容器编排文件，方便在本地或服务器上统一维护。当前整理目标是“私有内用、可放入 GitHub、避免提交运行态和敏感数据”。
+Douyin SparkFlow 是一个用于自动续火花的 Web 管理版部署包。推荐用 Docker Compose 部署，启动后在浏览器里完成管理员密码、扫码登录、目标好友勾选和发送窗口设置。
 
-## 仓库结构
+## 一键部署到服务器
 
-- `DouYinSparkFlow/`: 核心应用源码，包含 Web UI、任务调度、账号登录与消息发送逻辑。
-- `proxy/`: 代理容器配置目录，当前包含 `mihomo` 配置文件。
-- `docker-compose.yml`: 统一的容器编排入口。
-- `refresh_proxy.sh`: 代理刷新脚本。
+适合 Ubuntu/Debian/CentOS 类服务器：
 
-## 运行方式概览
+```bash
+curl -fsSL https://raw.githubusercontent.com/halfwaystudent/douyin-sparkflow/main/deploy/install-server.sh | bash
+```
 
-- 支持本地运行核心应用，也支持通过 `docker-compose.yml` 在服务器上部署。
-- Web 管理入口、交互式登录桌面和定时任务都由仓库内现有脚本与配置驱动。
-- 定时发送、账号状态和消息模板属于运行时行为，不在本仓库中直接携带账号数据。
+也可以指定安装目录或代理订阅：
 
-## 配置与敏感文件
+```bash
+curl -fsSL https://raw.githubusercontent.com/halfwaystudent/douyin-sparkflow/main/deploy/install-server.sh | APP_ROOT=/opt/douyin-sparkflow PROXY_SUB_URL='你的 Mihomo/Clash 订阅链接' bash
+```
 
-以下内容不会进入当前 Git 仓库，需要在实际部署环境中自行补齐：
+部署完成后打开：
+
+- Web 面板：`http://服务器IP:8787`
+- 扫码登录桌面：Web 面板里的“登录桌面”入口，默认端口 `8788`
+
+首次使用流程：
+
+1. 创建管理员账号密码。
+2. 打开登录桌面，扫码登录抖音。
+3. 保存登录态。
+4. 刷新好友列表，勾选要续火花的目标好友。
+5. 设置发送窗口，例如 `10:00-18:00/10m`。
+
+## 本地部署
+
+Windows 本地需要先启动 Docker Desktop，然后运行：
+
+```powershell
+.\deploy\install-local.ps1
+```
+
+带代理订阅：
+
+```powershell
+.\deploy\install-local.ps1 -ProxySubUrl "你的 Mihomo/Clash 订阅链接"
+```
+
+脚本会创建 `.env`、运行态目录和默认代理配置，然后执行 `docker compose up -d --build` 并打开 Web 面板。
+
+Linux/macOS 本地可以运行：
+
+```bash
+./deploy/install-local.sh
+```
+
+## 常用命令
+
+```bash
+docker compose ps
+docker compose logs -f web
+docker compose logs -f scheduler
+docker compose up -d --build
+docker compose down
+```
+
+刷新代理订阅：
+
+```bash
+./refresh_proxy.sh
+docker compose restart proxy
+```
+
+如果 `.env` 里的 `PROXY_SUB_URL` 为空，系统会使用 `proxy/config.example.yaml` 生成一个直连配置。
+
+## 目录结构
+
+- `DouYinSparkFlow/`：核心应用、Web UI、登录桌面和发送任务。
+- `docker-compose.yml`：统一容器编排入口，包含 Web、登录桌面、定时器、任务和代理服务。
+- `deploy/`：服务器和本地一键部署脚本。
+- `proxy/config.example.yaml`：安全的代理配置模板。
+- `.env.example`：部署环境变量模板。
+
+## 不提交的运行态文件
+
+这些内容包含账号、登录态、日志或本机配置，不应提交到 GitHub：
 
 - `.env`
 - `state/`
 - `logs/`
+- `proxy/config.yaml`
+- `DouYinSparkFlow/logs/`
 - `DouYinSparkFlow/usersData.json`
 - `DouYinSparkFlow/webui_settings.json`
 - `DouYinSparkFlow/.im_sdk_cache/`
 
-如果需要复现运行环境，建议在目标机器上重新生成这些文件，而不是从仓库恢复。
+## 许可
 
-## 使用边界
-
-- 本仓库按内部项目资料整理，主要用于源码管理、部署维护和环境迁移。
-- 使用者需要自行评估平台规则、账号风险和运行后果。
-- 不建议把真实账号数据、浏览器登录态、日志或运行缓存提交到仓库。
-
-## 许可证
-
-核心应用当前采用 MIT 协议，许可证文件位于 [DouYinSparkFlow/LICENSE](DouYinSparkFlow/LICENSE)。
-
-如需查看源码级说明，请优先阅读 [DouYinSparkFlow/README.md](DouYinSparkFlow/README.md)。
+核心应用采用 MIT 协议，详见 [DouYinSparkFlow/LICENSE](DouYinSparkFlow/LICENSE)。