zikai
9af28f41b4
死代码移除: - whiteboard_hub.py: 移除未引用的 reset_hub 单例重置函数 - tunnel_service.py: 移除未引用的 is_port_allowed (逻辑已在 sftp_server 内联) - tunnel_session_dao.py: 移除未引用的 get_active_by_port - pdf_job_dao.py: 移除未用 datetime 导入 - pdf_converter.py: 移除未用 shutil 导入 - pdf_service.py: 移除未用 PdfSubmitResponse 导入 + _do_convert 内未用 hashlib 导入 - upload_html.py: 移除未用 escape 导入 (JS 侧自有 escapeHtml) - pdf_controller.py: 移除 _resolve_cookie 内未用 cfg 局部变量 提前失败/分层修复: - database.py init_db_schema: 建表后用 inspector 校验既有表列与模型一致, 缺列即抛 RuntimeError (fail-fast on schema drift), 避免运行期才暴露 - whiteboard_dao.get_or_create: 仅 IntegrityError 才回滚重读, 其他异常向上抛 (原 except Exception 会掩盖 schema/连接等真实故障) - pdf_service.admin_delete/_safe_delete_file: 改用 PdfJobDAO.delete / UploadedFileDAO.delete, 不再直接操作 job_dao.db / file_dao.db (修复分层契约: DAO 头注释声明 service 不直接操作 session) - PdfJobDAO 新增 delete(job) 方法 日志补全 (8 处 silent catch): - whiteboard_hub.py disconnect/close_board 关闭 ws: logger.debug - whiteboard_controller _safe_send/_safe_close: logger.debug - sftp_server _close_tunnel_dao/读用户名: logger.debug - sftp_server validate_public_key: logger.warning (auth 路径, 避免静默失败) 文档: - 新增 docs/routes.md, docs/configuration.md, docs/error-handling.md - README.md 精简为简介/结构/外部依赖/apache2 配置/Ubuntu 安装/docs 链接
40 lines
2.0 KiB
Markdown
40 lines
2.0 KiB
Markdown
# 配置说明
|
||
|
||
所有运行时配置在 `config.yaml`（git-ignored）。完整 schema 见 `config.example.yaml`。
|
||
|
||
## 配置项
|
||
|
||
| 段 | 关键项 | 说明 |
|
||
|----|--------|------|
|
||
| `server` | `host`/`port` | 绑定地址，保持 `127.0.0.1:6867`（Apache 反代） |
|
||
| `database` | `host`/`port`/`user`/`password`/`database` | MySQL 连接；密码由 `setup.sh` 自动生成写回 |
|
||
| `storage` | `upload_dir` | 文件存储根目录（默认 `uploads`） |
|
||
| | `chunk_bytes` | 流式上传分片大小（默认 1 MiB） |
|
||
| | `chunk_session_dir` | 分片会话暂存目录（默认 `uploads/.work`） |
|
||
| | `chunk_session_ttl_seconds` | 被放弃会话存活秒数（默认 300） |
|
||
| `docs` | `username`/`password` | `/docs`、`/api/files-page`、`/api/wb-admin`、`/api/pdf-admin` 及 `/api/admin/*` 的 Basic Auth（明文，常量时间比较） |
|
||
| `sftp` | `enabled`/`host`/`port` | SFTP 服务，默认 `0.0.0.0:2022` |
|
||
| | `users[].username`/`password_hash` | SFTP 用户（bcrypt） |
|
||
| | `host_key_path`/`authorized_keys_path` | 主机密钥与公钥白名单路径 |
|
||
| `tunnel` | `enabled`/`users[]` | 反向隧道：`username`/`password_hash`/`tunnel_port`/`local_port` |
|
||
| `whiteboard` | `heartbeat_interval_seconds` | 心跳间隔（默认 3s） |
|
||
| | `heartbeat_miss_threshold` | 失活阈值（默认 5 次 = 15s） |
|
||
| | `max_board_id_length` | board_id 长度上限（默认 64） |
|
||
| | `max_connections_per_board` | 单白板并发连接上限（默认 50） |
|
||
| | `list_limit` | 管理页单次列表上限（默认 100） |
|
||
|
||
## 生成 bcrypt hash（SFTP/隧道用户密码）
|
||
|
||
```bash
|
||
.venv/bin/python -c "import bcrypt;print(bcrypt.hashpw(b'yourpass',bcrypt.gensalt()).decode())"
|
||
```
|
||
|
||
把输出填入 `config.yaml` 对应 `password_hash` 字段。
|
||
|
||
## 重新生成 DB 密码
|
||
|
||
```bash
|
||
.venv/bin/python -m app.scripts.init_db # 重置密码（写回 config.yaml）
|
||
KEEP_DB_PASSWORD=1 .venv/bin/python -m app.scripts.init_db # 保留现有密码，仅建库建账
|
||
```
|