docs(README): 重写为仅本分支修改的功能介绍 + 部署方式
删除上游原有介绍(核心特性/技术栈/目录说明/文件格式等), 保留:Docker 独立部署、OCR 图内文字搜索、Bug 修复、交互保持、 compose 与 docker run 两种部署方式、使用注意
This commit is contained in:
1 parent
65a539b2b5
commit
ffb47a0f81
1 file changed
+55
-100
@@ -1,87 +1,38 @@
|
||||
# FlyPic 飞图(Docker 独立部署版)
|
||||
|
||||
轻量、快速、稳定的图像素材检索浏览管理应用 —— 支持数十万张图片流畅浏览与 **OCR 图片内文字搜索**。本仓库为 [ZangXincz/FlyPic](https://github.com/ZangXincz/FlyPic) 的 Docker 化分支:上游已归档停更(原开发者不再使用飞牛)、飞牛应用商店下架,本分支让它以普通 Docker 容器继续运行,**不依赖飞牛 fnOS 应用框架**。
|
||||
本仓库是 [ZangXincz/FlyPic](https://github.com/ZangXincz/FlyPic) 的 Docker 化分支(上游已归档停更)。**本文档只介绍本分支修改过的功能与部署方式**,上游原有功能不再重复。
|
||||
|
||||
- 在线地址:`http://<主机IP>:15002`(首次打开设置管理员密码,随后添加素材库)
|
||||
- 访问:`http://<主机IP>:15002`(首次打开设置管理员密码,随后添加素材库)
|
||||
|
||||
## ✨ 核心特性
|
||||
## ✨ 本分支修改的功能
|
||||
|
||||
- 🚀 **轻量快速** - 数十万级图片流畅浏览,SQLite 本地索引 + 虚拟滚动瀑布流,毫秒级响应
|
||||
- 🔍 **智能搜索** - 多关键词 AND 匹配,**文件名 + 图片内 OCR 文字**同时检索(中英双语)
|
||||
- 🛡️ **非侵入式** - 只在素材目录创建 `.flypic` 索引文件夹,不修改任何原始文件
|
||||
- 🔄 **实时同步** - 文件新增/删除/修改自动更新索引,无需手动刷新
|
||||
- 📱 **现代界面** - 固定行高瀑布流、亮/暗主题、响应式移动端适配、右键菜单、撤销操作
|
||||
- 🔒 **管理员密码** - 登录保护素材库隐私
|
||||
- 🐳 **Docker 独立部署** - 多阶段构建,容器内路径与宿主机一致(中文路径直接可用)
|
||||
### 1. Docker 独立部署(新增)
|
||||
|
||||
## 🛠️ 技术栈
|
||||
- 多阶段 `Dockerfile` + `docker-compose.yml`,`docker compose up -d --build` 一键启动
|
||||
- **不依赖飞牛 fnOS 应用框架**,任意 Linux 主机可跑
|
||||
- **中文路径直接可用**:容器内路径与宿主机一致,素材库目录中文名原样挂载
|
||||
- 支持素材库目录**只读(`:ro`)挂载**(移除了原写权限校验,只验证可读)
|
||||
- apt 已换清华镜像源,修复 Docker Hub / Debian 官方源超时导致的构建失败
|
||||
|
||||
**前端**:React 18 + Vite 5 + TailwindCSS + Zustand + react-window + react-photo-view
|
||||
### 2. OCR 图片内文字搜索(新增)
|
||||
|
||||
**后端**:Node.js + Express + Sharp + better-sqlite3 + Socket.IO + tesseract(系统命令行 OCR)
|
||||
- 扫描图片时用系统 `tesseract`(`chi_sim` + `eng` 中英双语)提取图片内文字
|
||||
- 文字存入索引库 `ocr_text` 列(带索引),**搜索时文件名和图片内文字同时匹配**
|
||||
- OCR 失败不影响扫描主流程;镜像内已预装 tesseract 及中英文语言包
|
||||
|
||||
**架构**:三层架构(Config → Model → Service → Route)+ 模块化前端(Store → Hooks → API)
|
||||
### 3. Bug 修复
|
||||
|
||||
## 📁 目录说明
|
||||
- 修复添加素材库报 `Internal server error`(`LibraryService.js` 使用 `logger` 但未 require)
|
||||
- 修复中文路径素材库提示 `Path does not exist`
|
||||
- `.gitignore` 排除 `config/`(含 JWT 密钥与管理员密码哈希,禁止入库)
|
||||
|
||||
```
|
||||
flypic/
|
||||
├── Dockerfile # 多阶段构建(前端编译 → 后端依赖 → 运行时 + tesseract)
|
||||
├── docker-compose.yml # 一键部署(挂载素材库 + 持久化配置)
|
||||
├── CHANGELOG.md # 更新日志
|
||||
├── backend/ # Node.js 后端
|
||||
│ ├── utils/ocr.js # ✨ OCR 模块(系统 tesseract,chi_sim+eng)
|
||||
│ ├── utils/scanner.js # 扫描器(已集成 OCR 提取)
|
||||
│ ├── database/db.js # SQLite schema(新增 ocr_text 列 + 索引)
|
||||
│ └── src/ # config / models / services / routes / middleware
|
||||
├── frontend/ # React 前端(stores / hooks / api / components)
|
||||
├── scripts/ # 飞牛 fpk 打包脚本(上游遗留,Docker 部署不需要)
|
||||
├── 飞牛打包部署指南.md # 上游的 fpk 打包文档
|
||||
└── config/ # 运行时配置(gitignore,不入库)
|
||||
```
|
||||
### 4. 交互保持原样
|
||||
|
||||
## 🚀 部署 / 更新
|
||||
- 图片区保持原交互:**单击选中、Ctrl/Shift 多选、双击放大预览**(未改动)
|
||||
|
||||
```bash
|
||||
# 首次部署:编辑 docker-compose.yml 挂载你的素材库目录(容器内路径与宿主机一致)
|
||||
docker compose up -d --build
|
||||
## 🚀 部署方式
|
||||
|
||||
# 添加新素材库目录:volumes 加一行挂载后重启
|
||||
# - /vol2/1000/HD2/我的文档:/vol2/1000/HD2/我的文档
|
||||
docker compose up -d
|
||||
|
||||
# 更新代码
|
||||
git pull && docker compose up -d --build
|
||||
|
||||
# 日志 / 重启 / 停止
|
||||
docker compose logs -f
|
||||
docker compose restart
|
||||
docker compose down
|
||||
```
|
||||
|
||||
> 新增素材库需**重新扫描**后 OCR 文字才可被搜索到。镜像内预装 `tesseract-ocr` + `chi-sim` + `eng` 语言包,OCR 失败不影响扫描主流程。
|
||||
|
||||
### 方式一:docker run(单容器,不使用 compose)
|
||||
|
||||
```bash
|
||||
docker pull gitea.88531.cn/jinghui/flypic:latest
|
||||
|
||||
docker run -d --name flypic --restart unless-stopped \
|
||||
-p 15002:15002 \
|
||||
-e PORT=15002 \
|
||||
-e FRONTEND_DIST=/app/backend/public \
|
||||
-e NODE_ENV=production \
|
||||
-v /vol1/1000/HD1/docker/flypic/config:/root/.flypic \
|
||||
-v /vol2/1000/HD2/壁纸:/vol2/1000/HD2/壁纸 \
|
||||
gitea.88531.cn/jinghui/flypic:latest
|
||||
```
|
||||
|
||||
- 没有镜像就本地构建:`docker build -t flypic:1.0 .`,然后把上面的镜像名换成 `flypic:1.0`
|
||||
- 素材库目录按需增减 `-v`(容器内路径与宿主机一致),配置持久化在 `/root/.flypic`
|
||||
|
||||
### 方式二:Docker Compose部署
|
||||
|
||||
完整 `docker-compose.yml`(与仓库根目录文件完全一致,含全部 ports / volumes / environment):
|
||||
### 方式一:Docker Compose(推荐)
|
||||
|
||||
```yaml
|
||||
services:
|
||||
@@ -94,54 +45,58 @@ services:
|
||||
ports:
|
||||
- "15002:15002"
|
||||
volumes:
|
||||
# 素材库目录(容器内路径与飞牛一致,直接填实际路径即可)
|
||||
# 素材库目录(容器内路径与宿主机一致,中文路径直接填,按需增减)
|
||||
- /vol2/1000/HD2/壁纸:/vol2/1000/HD2/壁纸
|
||||
- /vol2/1000/HD2/我的文档:/vol2/1000/HD2/我的文档
|
||||
# 持久化配置(config.json 存储素材库路径、密码等,不用改)
|
||||
- /vol1/1000/HD1/docker/flypic/config:/root/.flypic
|
||||
# 持久化配置(素材库列表、管理员密码,不用改)
|
||||
- /vol3/1000/HD3/docker/flypic/config:/root/.flypic
|
||||
environment:
|
||||
- PORT=15002
|
||||
- FRONTEND_DIST=/app/backend/public
|
||||
- NODE_ENV=production
|
||||
# 如需挂载多个素材库,取消注释并修改路径:
|
||||
# volumes:
|
||||
# - /vol1/1000/图片库:/data/library1:ro
|
||||
# - /vol2/1000/素材:/data/library2:ro
|
||||
# - /vol1/1000/docker/flypic/config:/root/.flypic
|
||||
```
|
||||
|
||||
```bash
|
||||
docker compose up -d --build # 首次构建并启动
|
||||
docker compose up -d # 日常更新 / 重启
|
||||
# 首次部署(编辑 volumes 换成你的素材库目录)
|
||||
docker compose up -d --build
|
||||
|
||||
# 新增素材库:volumes 加一行挂载后重启
|
||||
docker compose up -d
|
||||
|
||||
# 更新代码
|
||||
git pull && docker compose up -d --build
|
||||
|
||||
# 日志 / 重启 / 停止
|
||||
docker compose logs -f
|
||||
docker compose restart
|
||||
docker compose down
|
||||
```
|
||||
|
||||
## 📦 其他部署方式
|
||||
### 方式二:docker run(单容器)
|
||||
|
||||
- **飞牛 fpk 应用包**:见 [飞牛打包部署指南](./飞牛打包部署指南.md)(`npm run build:fpk:docker` → `fnpack build`,仅当飞牛应用框架可用时适用)
|
||||
- **裸机开发**:`npm install` 后分别 `npm run dev:frontend`(5173)与 `npm run dev:backend`(15002)
|
||||
```bash
|
||||
docker pull gitea.88531.cn/jinghui/flypic:latest
|
||||
|
||||
## 📝 数据存储
|
||||
|
||||
```
|
||||
素材库目录/
|
||||
├── 用户图片文件...
|
||||
└── .flypic/ # 索引数据(隐藏目录)
|
||||
├── thumbnails/ # WebP 缩略图
|
||||
└── metadata.db # SQLite(含 ocr_text 列)
|
||||
|
||||
项目 config/ # 应用配置(JWT 密钥、素材库列表),已 gitignore
|
||||
docker run -d --name flypic --restart unless-stopped \
|
||||
-p 15002:15002 \
|
||||
-e PORT=15002 \
|
||||
-e FRONTEND_DIST=/app/backend/public \
|
||||
-e NODE_ENV=production \
|
||||
-v /vol3/1000/HD3/docker/flypic/config:/root/.flypic \
|
||||
-v /vol2/1000/HD2/壁纸:/vol2/1000/HD2/壁纸 \
|
||||
gitea.88531.cn/jinghui/flypic:latest
|
||||
```
|
||||
|
||||
删除素材库下的 `.flypic` 即可完全清除该库索引,重新扫描重建。
|
||||
- 没有镜像就本地构建:`docker build -t flypic:latest .`,替换上面的镜像名
|
||||
- 素材库目录按需增减 `-v`(容器内路径与宿主机一致)
|
||||
|
||||
## 🎯 支持的文件格式
|
||||
## 📝 使用注意
|
||||
|
||||
**完整支持**:JPG、PNG、WebP、GIF、BMP、TIFF、SVG
|
||||
|
||||
**可识别**:视频(MP4/MOV/AVI...)、音频(MP3/WAV...)、文档(PDF/TXT...)、设计文件(PSD/AI...)
|
||||
- **添加/更新素材库后需重新扫描**,图片内 OCR 文字才可被搜索到(旧索引无文字数据)
|
||||
- 素材库全量 OCR 扫描逐张识别、耗时较长,建议在不用的时候执行
|
||||
- 数据存储:素材目录下 `.flypic/`(缩略图 + SQLite 索引,含 `ocr_text` 列);应用配置在 `config/`(已 gitignore)
|
||||
- 删除素材目录下的 `.flypic` 即可清除该库索引,重新扫描重建
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT License - 详见 [LICENSE](./LICENSE) 文件,衍生自 [ZangXincz/FlyPic](https://github.com/ZangXincz/FlyPic)。
|
||||
|
||||
**上游官网**:[FlyPic 介绍页](https://flypic.shikejk.com/) | **本分支**:Docker 化 + OCR 搜索
|
||||
Reference in new issue
Block a user