Skip to content

Commit c3d9446

Browse files
committed
docs: 更新README文档,添加文件与隐私说明及Web管理端使用指南
- 新增文件与隐私说明,强调敏感信息的管理和备份 - 添加Web管理端的使用指南,包括本地运行和Docker运行的步骤 - 删除不再使用的本地数据库文件web_signin.db
1 parent 8be3b23 commit c3d9446

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,51 @@ pip install -r requirements.txt
146146
- **Linux**: 使用 `crontab` 设置定时任务。
147147
- **云函数**: 可部署至云函数平台。
148148

149+
## 文件与隐私说明
150+
151+
- `data.json``.env` 等文件中包含个人 Cookie、经纬度、推送 Key 等敏感信息,**不会被提交到 Git 仓库**(已在 `.gitignore` 中忽略),请妥善保管本地副本并做好备份。
152+
- `web_signin/` 目录下的本地数据库文件 `web_signin/db/web_signin.db` 也已默认加入 `.gitignore`,仅用于本地运行和调试,不会上传到远程仓库。
153+
- 如需分享或上传日志/截图,请注意**手动打码或删除其中的 Cookie、班级 ID、经纬度等个人隐私信息**
154+
155+
## web_signin Web 管理端
156+
157+
`web_signin/` 提供了一个基于 Flask + 前端页面的**Web 管理界面**,用于在浏览器中管理用户、查看签到任务等。
158+
159+
### 本地直接运行
160+
161+
1. 安装 Web 版依赖(在项目根目录执行):
162+
```bash
163+
pip install -r web_signin/requirements.txt
164+
```
165+
2. (可选)在 `web_signin/` 目录下复制一份配置模板:
166+
```bash
167+
cd web_signin
168+
copy config.json.example config.json # Windows
169+
#
170+
cp config.json.example config.json # Linux / macOS
171+
```
172+
如需自定义 Web 端口,可在 `config.json` 中填写 `"port": 9988` 等数值,或通过环境变量 `WEB_SIGNIN_PORT` 覆盖。
173+
3. 启动 Web 服务:
174+
```bash
175+
python web_signin/run.py
176+
```
177+
4. 在浏览器访问:
178+
```text
179+
http://127.0.0.1:9988
180+
```
181+
若修改了端口,请将 `9988` 替换为实际端口。
182+
183+
### 使用 Docker 运行
184+
185+
项目内已提供 `web_signin/Dockerfile`,可用于快速构建和运行 Web 版:
186+
187+
```bash
188+
docker build -t bjmf-web -f web_signin/Dockerfile .
189+
docker run -d --name bjmf-web -p 9988:9988 bjmf-web
190+
```
191+
192+
如需调整端口,可修改映射 `-p 宿主端口:容器端口`,或通过环境变量 `WEB_SIGNIN_PORT` 覆盖容器内部端口。
193+
149194
## 注意事项
150195

151196
- 程序会自动检测并填充空的 class 字段。

web_signin/db/web_signin.db

-40 KB
Binary file not shown.

0 commit comments

Comments
 (0)