https://github.com/hiroi-sora/umi-ocr_runtime_linux
Umi-OCR Linux 运行环境
https://github.com/hiroi-sora/umi-ocr_runtime_linux
umi-ocr
Last synced: about 2 months ago
JSON representation
Umi-OCR Linux 运行环境
- Host: GitHub
- URL: https://github.com/hiroi-sora/umi-ocr_runtime_linux
- Owner: hiroi-sora
- License: mit
- Created: 2024-06-04T16:03:51.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-31T13:26:18.000Z (8 months ago)
- Last Synced: 2025-02-26T02:16:54.964Z (about 2 months ago)
- Topics: umi-ocr
- Language: Python
- Homepage:
- Size: 93.8 KB
- Stars: 66
- Watchers: 4
- Forks: 17
- Open Issues: 11
-
Metadata Files:
- Readme: README-docker.md
- License: LICENSE
Awesome Lists containing this project
README
# Umi-OCR Docker 部署
部署前，请检查主机的CPU是否具有AVX指令集：
```sh
lscpu | grep avx
```
如果输出了类似如下的结果，那么可以继续部署。
```
Flags: ... avx ... avx2 ...
```
**如果看不到任何输出，这表明当前CPU不支持AVX指令集，暂时无法使用 Umi-OCR-Linux 。**
## 1. 下载 Dockerfile
```sh
wget https://raw.githubusercontent.com/hiroi-sora/Umi-OCR_runtime_linux/main/Dockerfile
```
## 2. 构建镜像
```sh
docker build -t umi-ocr-paddle .
```
说明：
- 设置镜像名称为 `umi-ocr-paddle` 。（Dockerfile默认下载使用 PaddleOCR-json 引擎）
> 构建过程中会自动从 Github 下载 Umi-OCR 发行包等文件。如果遇到网络问题，可能需要设置代理：
>
> ```sh
> docker build -t umi-ocr-paddle . \
> --build-arg HTTP_PROXY=http://X.X.X.X:7897 \
> --build-arg HTTPS_PROXY=http://X.X.X.X:7897
> ```
## 3. 运行容器
### 无头模式
适合在没有显示器的云服务器、不支持X显示协议的系统、或者不需要GUI界面时使用。让 Umi-OCR 提供 HTTP 接口服务。
```sh
docker run -d --name umi-ocr \
-e HEADLESS=true \
-p 1224:1224 \
umi-ocr-paddle
```
说明：
- 设置容器名称为 `umi-ocr` 。你也可以设置为任意名称。
- 设置环境变量 `-e HEADLESS=true` 启用无头模式。
- 设置端口转发 `-p xxxx:1224` ，将容器内的1224端口转发给主机xxxx端口。
- 使用的镜像为 `umi-ocr-paddle` 。
- [HTTP接口手册](https://github.com/hiroi-sora/Umi-OCR/blob/main/docs/http/README.md)
### GUI 模式
适合在有显示器的 Xorg 桌面环境下使用，可使用截屏、文件导入等功能。
需要在主机上开放 X 服务权限，允许容器内的应用连接到宿主机桌面。
```sh
xhost +
```
```sh
docker run -d --name umi-ocr \
-v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$DISPLAY \
-v /home:/home \
-p 1224:1224 \
umi-ocr-paddle
```
说明：
- 将 `/tmp/.X11-unix` 挂载到容器内，将主机显示器信息 `$DISPLAY` 传给容器内环境。
- 将主机 `home` 目录挂载到容器内的 **相同路径** ，使文件拖拽导入的功能生效。
- 如果需要导入更多路径的文件，可自行挂载。注意，主机路径和容器路径必须相同，如 `-v /aa/bb/cc:/aa/bb/cc`。
- 容器运行后，等待数秒，即可在主机屏幕上显示 Umi-OCR 的窗口。
## 4. GUI 模式的控制
如果点击 Umi-OCR 窗口右上角的 × ，前台窗口会被关闭。但 Umi 仍会在后台活动，提供HTTP接口服务。
**重新打开窗口** 指令：
```sh
docker exec umi-ocr /bin/sh -c "/app/umi-ocr.sh --show"
```
**截图OCR** 指令：
```sh
docker exec umi-ocr /bin/sh -c "/app/umi-ocr.sh --screenshot"
```
更多指令请参考 [命令行手册](https://github.com/hiroi-sora/Umi-OCR/blob/main/docs/README_CLI.md) 。如果需要传入文件路径（如 `--path` 指令），请确保该文件的任意上级目录，在 `docker run` 时已通过 `-v` 挂载到容器中。
Docker GUI 模式可以使用大部分功能，就像主机中的普通应用一样：
- 访问宿主机内存，进行屏幕截图、粘贴图片。
- 访问宿主机硬盘，拖拽导入本地文件。（只能访问被挂载到容器中的路径）
Docker 中部分功能受限，无法使用：
- 创建桌面、开始菜单快捷方式。
- 系统托盘区图标。
如果在容器内部的命令行输出，发现以下报错，忽略即可，不用管。
```
ERROR: No native SystemTrayIcon implementation available.
Qt Labs Platform requires Qt Widgets on this setup.
Add 'QT += widgets' to .pro and create QApplication in main().
ERROR: No native Menu implementation available.
Qt Labs Platform requires Qt Widgets on this setup.
Add 'QT += widgets' to .pro and create QApplication in main().
```