60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
# X2WeChat Studio
|
||
|
||
把 X 上的优质文章快速改写为公众号可发布版本，并支持同步推送到 IM。
|
||
|
||
## 1. 启动
|
||
|
||
```bash
|
||
cp .env.example .env
|
||
# 填写 .env 中的 OPENAI / 微信 / IM 参数
|
||
|
||
docker compose up --build
|
||
```
|
||
|
||
启动后访问：`http://localhost:18000`
|
||
|
||
容器默认将数据库挂载到宿主机目录 `./data`（`AUTH_DB_PATH=/app/data/app.db`），更新容器镜像不会清空历史账号和会话数据。
|
||
|
||
## 2. 使用流程
|
||
|
||
1. 在页面左侧粘贴 X 文章内容。
|
||
2. 点击 `AI 改写`，自动生成标题、摘要、正文。
|
||
3. 点击 `发布到公众号草稿箱`。
|
||
4. 可选点击 `发送到 IM` 同步到团队群。
|
||
|
||
## 3. 环境变量说明
|
||
|
||
- `OPENAI_API_KEY`：AI 改写能力。
|
||
- `OPENAI_BASE_URL`：可选，兼容第三方网关。
|
||
- `OPENAI_MODEL`：默认 `gpt-4.1-mini`。
|
||
- `WECHAT_APPID` / `WECHAT_SECRET`：公众号发布必填。
|
||
- `WECHAT_AUTHOR`：草稿默认作者名。
|
||
- `IM_WEBHOOK_URL`：IM 推送地址（飞书/Slack/企微等）。
|
||
- `IM_SECRET`：可选签名。
|
||
- `AUTH_DB_PATH`：账号数据库文件路径（SQLite）。
|
||
- `AUTH_SESSION_TTL_SEC`：普通登录会话时长（秒）。
|
||
- `AUTH_REMEMBER_SESSION_TTL_SEC`：勾选“限时免登”时的会话时长（秒）。
|
||
- `AUTH_PASSWORD_RESET_KEY`：忘记密码重置码（用于“用户名+重置码”找回，默认 `x2ws-reset-2026`，建议改掉）。
|
||
|
||
## 4. 说明
|
||
|
||
- 未配置 `OPENAI_API_KEY` 时，系统会使用本地降级改写模板，便于你先跑通流程。
|
||
- 建议发布前人工复核事实与引用，避免版权和失真风险。
|
||
- 登录页支持“限时免登”，设置页支持修改密码；忘记密码页支持通过“用户名 + 重置码”重置密码。
|
||
|
||
## 5. 数据备份与恢复
|
||
|
||
数据库文件默认在 `./data/app.db`，可直接备份该文件：
|
||
|
||
```bash
|
||
cp ./data/app.db ./data/app.db.bak.$(date +%Y%m%d_%H%M%S)
|
||
```
|
||
|
||
恢复时停止服务后覆盖回去：
|
||
|
||
```bash
|
||
docker compose down
|
||
cp ./data/app.db.bak.YYYYMMDD_HHMMSS ./data/app.db
|
||
docker compose up -d
|
||
```
|