在 Raspberry Pi 上运行无纸化 NG
- 分类:树莓派主板教程
- 作者:杭州隽鹏电子科技有限公司
- 来源:MAKER:Emmet/译:隽鹏
- 发布时间:2022-12-20 14:09
- 访问量:0
【摘要】:
在本教程中,我们将展示如何在 Raspberry Pi 上安装和运行 Paperless-NG。
Paperless-NG 是一款功能强大的软件,旨在充当所有纸质文档的数字档案/索引。
当送入 Paperless-NG 文档时。它将对其执行 OCR(光学字符识别),将图像转换为可搜索和可选择的文本。
这只是无纸化功能的冰山一角。如果需要一个集中的地方来聚合文件,一定要试试这个软件。
Raspberry Pi 是无纸化 NG的优秀设备,因为它使用低电量,使其连续运行成本低廉。
为了获得 Paperless-NG 的最佳体验,应该使用具有 4GB 或更多内存的 Raspberry Pi 4 或更新版本。此外,如果还使用 64 位操作系统,它会有所帮助,以便它可以充分利用您设备的内存。
需要的设备
-
树莓派
-
微型 SD 卡
-
电源
-
以太网电缆或Wi-Fi
本教程在运行最新版本Raspberry Pi OS Bullseye 64 位的Raspberry Pi 400上进行了测试。
为无纸化 NG 准备 Raspberry Pi
本节将展示为无纸化 NG 准备 Raspberry Pi 的步骤。
我们需要在这里完成的两个主要任务是安装“ docker-compose”并创建一个目录,Paperless 将在其中获取文档。
1.在我们做任何事情之前,我们需要更新包列表并升级任何过时的包。
要完成这些任务,请在终端中运行以下两个命令。
sudoapt updatesudoapt upgrade
2.更新完成后,我们可以安装运行 Paperless-NG 所需的软件包。由于 Paperless 出现在 docker 容器中,我们只需要安装 Docker。
可以docker-compose使用以下命令将“ ”安装到 Raspberry Pi。
sudoaptinstalldocker-compose
3.现在我们已经安装了 Docker,我们需要创建一个目录,Paperless 将从中检索任何新文档。
对于本教程,我们将在用户的主目录中创建一个名为“ consume”的文件夹,该文件夹将位于另一个名为“ paperless”的目录中。
可以在终端中使用以下命令创建这些目录。
mkdir-p ~/paperless/consume
在 Raspberry Pi 上安装 Paperless-NG
准备好 Raspberry Pi 后,我们可以继续安装 Paperless-NG。在这些步骤中,我们将编写一个“ docker-compose.yml”文件和一个安装和运行 Paperless-NG 所需的环境文件。
1.让我们首先进入我们在前面的步骤中创建的目录。
可以在终端中使用 cd 命令更改到此目录。
cd ~/paperless/
创建 docker-compose.yml 文件
2.进入“ paperless”目录后,我们可以使用以下命令开始编写此 Docker 配置文件。
该文件告诉 Docker 它需要下载和运行哪些容器。
nano docker-compose.yml
3.在此配置文件中,键入以下行。我们将探索可能想要稍微调整的几个选项。
version:"3.4"services:
broker: image: redis:6.0 restart: unless-stopped webserver: image: jonaswinkler/paperless-ng:latest restart: unless-stopped depends_on: - broker ports: - 8000:8000 healthcheck: test:["CMD","curl","-f","http://localhost:8000"] interval: 30s timeout: 10s retries:5 volumes: - data:/usr/src/paperless/data - media:/usr/src/paperless/media - ./export:/usr/src/paperless/export - ./consume:/usr/src/paperless/consume env_file: docker-compose.env environment: PAPERLESS_REDIS: redis://broker:6379volumes: data: media:
4.在配置文件中,可能需要针对Paperless-NG进行一些调整以适合 Raspberry Pi。
如果愿意坚持使用默认设置,则可以跳到下一步。
更改无纸化 NG 运行的端口
可能想要更改的第一件事是 Paperless-NG 在 Raspberry Pi 上使用的端口。
默认情况下,它将在端口上运行,8000但可以将其更改为另一个端口。
要更改端口,需要替换冒号左侧的数字。
ports:
- 8000:8000
例如,如果想更改它以便 Paperless 在端口上运行8080,可以将其更改为如下所示。
ports: - 8080:8000
更改摄取目录
可能想要更改的另一个选项是 Paperless 将在 Raspberry Pi 上查找文件的位置。默认情况下,这将是名称为“ consume”的相对目录(我们在本教程的前面部分为此创建了一个位置)。
如果要更改 Paperless 从中导入文档的目录,则需要更改列左侧的目录。
- ./consume:/usr/src/paperless/consume
例如,如果想从安装在“ /mnt/paperless”的共享中导入文件夹,可以将此行更改为如下所示。
- /mnt/paperless:/usr/src/paperless/consume
5.完成此文件的编辑后,可以按CTRL+保存并退出X,然后按Y,然后按ENTER。
编写无纸化 NG 环境文件
6.我们需要一个随机字符串作为 Paperless-NG 的密钥。
可以在终端中使用以下命令生成随机密钥。
cat /dev/urandom |tr-dc'a-zA-Z0-9'|fold-w64|head-n1
运行此命令后,应该会得到如下所示的结果。复制此字符串,因为我们将在下一步中使用它。
McziUH4c8lidzd4wggZj5q1tpgBv7DcPMtFv5RD7f0rFUrQFOmh8rSOiuMwp9N6P
7.我们可以docker-compose.env通过运行以下命令开始编写“”文件。
nano docker-compose.env
8.在此文件中,您需要编写以下行。我们将在插入时解释每一部分。我们将添加的第一行设置无纸化的密钥。将“ ”替换在第 6 步YOURSECRETKEY中生成的密钥。
PAPERLESS_SECRET_KEY=YOURSECRETKEY
9.让我们从“ USERMAP”选项开始。这些选项将 Docker 容器映射到特定的用户和组。使用 Raspberry Pi OS 时,主要用户的 ID 为1000.
如果使用的是不同的,则需要更改这些值
USERMAP_UID=1000USERMAP_GID=1000
10.下一个选项允许为无纸化添加其他语言以支持 Raspberry Pi。如果只需要默认语言,则可以跳过添加此选项。
默认情况下,Paperless 支持英语、德语、意大利语、西班牙语和法语。但是,通过查看 Debian 软件包列表,该软件可以支持更多。
每种附加语言都应通过其三字母代码(EGces表示捷克语)进行引用。可以通过用一个空格分隔每种语言来添加多种其他语言
PAPERLESS_OCR_LANGUAGES=ADDITIONAL LANGS HERE
11.默认情况下,Paperless-NG 将使用 UTC 时区。PAPERLESS_TIME_ZONE但是,我们可以通过设置“ ”选项将其更改为您当地的时区。
可以在维基百科上找到时区列表。要的值在“ TZ database name”列中。
例如,我们将使用以下行将时区设置为澳大利亚霍巴特。
PAPERLESS_TIME_ZONE=Australia/Hobart
12.我们将在本节中探讨的最后一个选项是设置无纸化将在 Raspberry Pi 上用于 OCR 的默认语言。
应该将此选项设置为大部分文档将使用的语言。
通过我们在下面添加的行,我们将默认语言设置为英语。
PAPERLESS_OCR_LANGUAGE=eng
13.完成后,可以按CTRL+保存并退出X,然后按Y, 然后按ENTER键。
在 Raspberry Pi 上运行无纸化 NG 安装
14.最后,我们可以使用以下命令在树莓派上运行无纸化。
Docker 将立即开始下载所有需要的容器并使用我们的配置启动它们。
sudodocker-compose up -d
15.一旦 Paperless-NG 在 Raspberry Pi 上启动并运行,将需要创建一个用户。
要启动此过程,必须在终端中运行以下命令。
sudodocker-compose run --rm webserver createsuperuser
16.将被要求的第一件事是为新用户指定一个用户名。
如果在ENTER不输入任何内容的情况下按下,Paperless 将创建名为“ paperless”的用户。
Username (leave blank to use 'paperless'):
17.现在将要求选择性地输入该用户的电子邮件地址。
如果不想给用户分配电子邮件,可以离开这个空间。
Email address:
18.接下来,将需要输入该用户的密码。确保这是安全的,并且不会与电子邮件地址或用户名过于接近。
Password:
将需要重新输入密码以进行确认。
Password (again):
20.如果 Paperless-NG 用户已成功创建,应该会在终端中看到以下消息。
现在可以继续在 Raspberry Pi 上登录和使用 Paperless。
Superuser created successfully.
使用 Raspberry Pi 的无纸化网络界面
在接下来的几节中,我们将向您展示如何访问和使用 Paperless-NG 的网络界面。
本节只需要您最喜欢的网络浏览器和与 Raspberry Pi 的连接。
访问无纸化网络界面
1.要访问 Raspberry Pi 上的 Paperless-NG 网络界面,需要知道它的 IP 地址。
获取 Raspberry Pi IP 的最简单方法是在终端中使用主机名命令。
hostname-I
通常,分配给 Pi 的 IP 将是列出的第一个地址。
2.知道 Raspberry Pi 的 IP 地址后,将需要转到以下地址。
确保IPADDRESS用 IP 替换“ ”。8000如果更改了 Docker 配置文件中的端口,还需要更改端口“ ”。
http://IPADDRESS:8000
3.现在将看到无纸化登录屏幕。在此屏幕上,需要填写在上一节中设置的用户名和密码 ( 1. )。
填写登录详细信息后,click“ Sign in”按钮 ( 2. )。
4.现在将看到 Paperless-NG 仪表板。可以使用此仪表板查看所有文档并进行管理。
甚至可以使用此界面将文档手动上传到 Paperless 进行处理。
通过 Web 界面将文档上传到无纸化
5.要通过无纸化将文件上传到 Raspberry Pi,需要将其拖放到左侧边栏中,如图所示。
或者,可以点击click“ Browse files”按钮,手动选择要上传的文件。
6.将文件上传到 Paperless 后,它将自动开始处理文档。
此过程可能需要时间,因为它需要扫描整个文档。
编辑已处理的文档
7.将文档上传到无纸化后,就可以编辑为其生成的元数据。这对于正确分类上传的所有不同文档很有用。
编辑元数据还有助于 Paperless 的机器学习自动对文档进行分类。
要编辑文档,可以在上传后立即click“ Open document”(1. )。
Documents或者,可以在“ ”页面 ( 2. )上找到这些文档
8.下面,可以看到我们上传到 Paperless 的屏幕截图的编辑屏幕。
它试图扫描文档,让轻松突出显示和复制文本。
可以使用文档屏幕编辑有关此文档的各种详细信息,例如标题、标签、文档类型等。
结论
现在应该已经在 Raspberry Pi 上启动并运行了 Paperless-NG。