tutorial.md

前置准备

• 下载并安装 UmiOCR, 解压并运行该程序, 运行该应用保持在后台

安装使用

Warning

需要完成 #前置准备

到 Release 页面下载对应平台的压缩包, 解压后使用命令行/终端运行, 以下命令查看更多帮助

./bookxnote-local-ocr -h # 或 Windows 上 .\bookxnote-local-ocr.exe -h

以下命令均需要在解压后的程序根目录下运行!

Linux

1. 下载并解压 tar.gz 文件
2. 进入解压后的目录
3. 运行配置权限脚本：

   chmod +x setup-privileges.sh
   sudo ./setup-privileges.sh
   
4. 安装一些配置, 查看运行提示操作

./bookxnote-local-ocr install

之后仅需要在使用BookxNote OCR功能时, 运行该命令, 保持终端存在, 不要关闭

./bookxnote-local-ocr server

可以使用GUI程序(功能和Cli一致, 但是可以托盘管理)

./bookxnote-local-ocr gui

Windows

解压后会看到以下文件：

• install.bat - 用于安装证书和配置hosts
• start.bat - 每次使用OCR功能时运行, 保持窗口开启
• uninstall.bat - 清理证书和hosts配置

Note

• 以上.bat文件都需要管理员权限, 请用管理员权限打开(右键找到以管理员身份运行)

使用步骤：

1. 首次使用时需要运行一次, 使用管理员权限运行install.bat, 按提示操作
2. 每次需要使用OCR时, 使用管理员权限运行start.bat, 保持窗口开启

也可以使用命令行方式运行, 需要管理员权限

.\bookxnote-local-ocr.exe install  # 首次安装
.\bookxnote-local-ocr.exe server   # 启动服务

打开 BookXNote, 在右上角选项-文字识别中(需要高级用户)随意配置 API Key 和 Secret Key, 点击应用后检查输出是否为 "应用OCR成功"

如果成功, 则可以正常使用 OCR 功能, 否则参考 #QA 排查问题

卸载

在解压后的目录中运行以下命令

Linux

sudo ./bookxnote-local-ocr uninstall

Windows

如果不再使用, 双击运行uninstall.bat清理配置 或使用管理员权限打开powershell运行以下命令

.\bookxnote-local-ocr.exe uninstall

后手动删除安装目录

本地开发运行

Linux

Warning

需要完成 #前置准备

• 安装并正确配置 Golang
• 运行 make build 会自动下载依赖并完成编译
• 浏览代码, 进行开发 :)

QA

1. BookXNote 中配置的 API Key 和 Secret Key 后点击应用, 出现非成功提示?

• 检查是否正确配置了 hosts
• 检查是否已安装并信任自签发的根证书
• 检查 OCR 服务 (如 UmiOCR) 是否正常运行
• 如果以上都没有问题, 请重启 BookXNote , OCR 服务和本服务重试

ArchLinux 用户如果遇到根证书无法安装问题, 请参考 https://wiki.archlinux.org/title/User:Grawity/Adding_a_trusted_CA_certificate 手动信任, 详细见 makefile

2. 配置文件查找顺序?

程序支持通过配置文件自定义设置。配置文件使用YAML格式, 如

# ...
ocr:
  umiocr:
    api_url: http://127.0.0.1:1224  # UmiOCR服务地址
# ...

配置文件位置（按优先级排序）：

0. 可执行程序所在目录

查看 config.yml 获取更多默认配置信息