「Paperless」の版間の差分

2024年4月12日 (金) 19:28時点における版

Paperless は、スキャンした文書を索引付けし、文書を簡単に検索したり、文書と一緒にメタデータを保存することができるオープンソースの文書管理システムです。この記事は、Paperless-ngx に関するもので、これは Paperless-ng のコミュニティによって維持されているフォークであり、さらにそれは元の Paperless プロジェクトのフォークであり、両方とも放棄されています。

インストール

paperless-ngx^AUR パッケージをインストールします。

フォルダ

Paperless は /usr/share/paperless にインストールされます。Paperless の永続的なストレージは /var/lib/paperless に位置しており、media フォルダ、デフォルトで SQLite データベースを含む data フォルダ、文書を消費する consume フォルダ、一時的な uploads フォルダおよび tmp 変換フォルダを含んでいます。 consume フォルダは paperless グループのすべてのユーザーに対して書き込み権限があります。

消費フォルダの権限

ユーザー（例えば "http"）が消費フォルダに文書を置くことを許可したい場合は、それらのユーザーを paperless ユーザーグループに追加してください。

OCR 言語

Paperless で英語以外の言語の文書を処理したい場合、対応する tesseract 言語データパッケージをインストールする必要があります。ドイツ語の場合は tesseract-data-deu がそれに該当します。

生成された PDF 文書のサイズを減らす

生成された PDF 文書のサイズを減らすために、オプションの依存関係 jbig2enc-git^AUR をインストールすることができます。これにより Paperless は PDF のサイズを小さくすることが可能です。

Paperless-ng からの移行

もし paperless-ng がインストールされており、paperless-ngx^AUR に移行したい場合、paperless-ngx^AUR をインストールし、尋ねられた際に paperless-ng を削除することを選択できます。データは失われません。それでも、root として次のコマンドを実行する必要があります：

# paperless-manage makemigrations

その後、paperless ユーザーとして通常のデータベースマイグレーションを適用します：

[paperless]$ paperless-manage migrate

最後に、paperless.target を再起動してください。

開始

paperless.target を開始/有効化してください。これで、Paperless インスタンスはポート 8000 で利用可能になるはずです。

設定

Paperless の設定の詳細については、その公式ドキュメントを参照してください。設定ファイルは /etc/paperless.conf にあります。

ノート: paperless-ngx^AUR パッケージは paperless システムユーザーを作成し、常に paperless ユーザーとして実行されるべき paperless-manage コマンドを提供しています。例については以下を参照してください。公式ドキュメントで python3 manage.py と言及されている場所ではいつも paperless-manage コマンドを使用してください。

設定を変更した後は、paperless.target を再起動するのを忘れないでください。

設定をニーズに合わせて調整

/etc/paperless.conf にある設定ファイルを開き、特に OCR に関するパラメーターを含む、あなたのニーズに合わせてパラメーターを調整してください。個々の設定の説明については、公式ドキュメントを参照してください。

シークレットキーの設定

初回インストール後、シークレットキーを生成して設定する必要があります。覚えておく必要はありませんが、署名付きデータのセキュリティに使用されるため、秘密にしておくべきです。シークレットキーを設定するには、以下の行のコメントを外して変更してください：

/etc/paperless.conf

#PAPERLESS_SECRET_KEY=change-me

キーを生成して設定ファイルに設定するには、次のコマンドを実行します：

# sed -i /etc/paperless.conf -e "s|#PAPERLESS_SECRET_KEY=change-me|PAPERLESS_SECRET_KEY=$(date | md5sum | awk '{print $1;}')|"

データベースマイグレーションの実行

初回インストール後およびアップデート後には、データベースマイグレーションを実行する必要があります：

[paperless]$ paperless-manage migrate

管理ユーザーの作成

初回インストール後、Paperless インスタンスの管理ユーザーを作成する必要があります：

[paperless]$ paperless-manage createsuperuser

Nginx

Nginx をインストールし、Paperless のバーチャルホストのための以下の設定を起点として使用してください：

/etc/nginx/sites-available/paperless.domain.tld

server {

    server_name paperless.domain.tld;
    listen 80;
    listen [::]:80;

    location / {

        # Adjust host and port as required.
        proxy_pass http://localhost:8000/;

        # These configuration options are required for WebSockets to work.
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        proxy_redirect off;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Host $server_name;
    }

}

Pacman フック

パッケージの更新時に Paperless データベースのマイグレーションを自動的に実行するために、含まれている pacman フックを利用できます：

# mkdir -vp /etc/pacman.d/hooks
# ln -sv /usr/share/paperless/docs/paperless.hook /etc/pacman.d/hooks/

トラブルシューティング

文書のインポート時に BadSignature エラーが記録される

文書のインポートを試みた際に BadSignature エラーが出る場合、/etc/paperless.conf にある設定ファイルが考慮されていない可能性が高いです。これは、テンプレートの設定ファイル /usr/share/paperless/paperless.conf が優先されているためです。この場合、/usr/share/paperless/paperless.conf を削除または名前を変更し、paperless.target を restart してください。

誤設定されたリトライとタイムアウトに関する警告

リトライとタイムアウトが誤設定されているという警告が出る場合、それは安全に無視できますし、python-django-q におけるシンプルなアップストリームの修正を待つことができます。警告は以下のように表示されるでしょう：

gunicorn[29457]: /usr/lib/python3.9/site-packages/django_q/conf.py:136: UserWarning: Retry and timeout are misconfigured. Set retry larger than timeout,
gunicorn[29457]:         failure to do so will cause the tasks to be retriggered before completion.
gunicorn[29457]:         See https://django-q.readthedocs.io/en/latest/configure.html#retry for details.
gunicorn[29457]:   warn("""Retry and timeout are misconfigured. Set retry larger than timeout,

ImageMagick でのサムネイル生成が失敗する

/etc/ImageMagick-7/policy.xml でポリシールールを無効にする必要があります。次の行をコメントアウトするために  を追加してください：

/etc/ImageMagick-7/policy.xml

<!-- <policy domain="delegate" rights="none" pattern="gs" /> -->

ImageMagick 記事の冒頭で述べられている可能性のあるセキュリティ上の影響を考慮してください。また、ImageMagick のポリシールールが有効なままの場合、Paperless はとにかく ghostscript を使用するようにフォールバックすることも覚えておいてください。

コンシューマーサービスが常に 1 つの CPU コアを 100% で使用する

/etc/paperless.conf 設定ファイルの PAPERLESS_CONSUMER_POLLING 設定に関する行のコメントを解除してください：

/etc/paperless.conf

PAPERLESS_CONSUMER_POLLING=10

翻訳ステータス: このページは en:Paperless の翻訳バージョンです。最後の翻訳日は 2024/04/12 です。もし英語版に変更があれば、翻訳の同期を手伝うことができます。

@@ 1行目: / 1行目: @@
 [[Category:サーバー]]
 [[en:Paperless]]
-[https://github.com/paperless-ngx/paperless-ngx Paperless] is an open source document management system that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents. This article refers to ''Paperless-ngx'', a community-maintained fork of [https://github.com/jonaswinkler/paperless-ng Paperless-ng], which in turn is a fork of the [https://github.com/the-paperless-project/paperless original] Paperless project that have both been given up.
+[https://github.com/paperless-ngx/paperless-ngx Paperless] は、スキャンした文書を索引付けし、文書を簡単に検索したり、文書と一緒にメタデータを保存することができるオープンソースの文書管理システムです。この記事は、''Paperless-ngx'' に関するもので、これは [https://github.com/jonaswinkler/paperless-ng Paperless-ng] のコミュニティによって維持されているフォークであり、さらにそれは [https://github.com/the-paperless-project/paperless 元の] Paperless プロジェクトのフォークであり、両方とも放棄されています。
-== Installation ==
+== インストール ==
-[[Install]] the {{AUR|paperless-ngx}} package.
+{{AUR|paperless-ngx}} パッケージを[[インストール]]します。
-=== Folders ===
+=== フォルダ ===
-Paperless gets installed to {{ic|/usr/share/paperless}}. The persistent storage of Paperless is located at {{ic|/var/lib/paperless}} and contains the {{ic|media}} folder, the {{ic|data}} folder (by default containing the SQLite database), the {{ic|consume}} folder for document consumption, the temporary {{ic|uploads}} folder and {{ic|tmp}} convert folder.
+Paperless は {{ic|/usr/share/paperless}} にインストールされます。Paperless の永続的なストレージは {{ic|/var/lib/paperless}} に位置しており、{{ic|media}} フォルダ、デフォルトで SQLite データベースを含む {{ic|data}} フォルダ、文書を消費する {{ic|consume}} フォルダ、一時的な {{ic|uploads}} フォルダおよび {{ic|tmp}} 変換フォルダを含んでいます。
+{{ic|consume}} フォルダは {{ic|paperless}} グループのすべてのユーザーに対して書き込み権限があります。
-The {{ic|consume}} folder has write permissions for everyone in the {{ic|paperless}} group.
-=== Consumption folder permissions ===
+=== 消費フォルダの権限 ===
+ユーザー（例えば "http"）が消費フォルダに文書を置くことを許可したい場合は、それらのユーザーを {{ic|paperless}} [[ユーザーグループ]] に追加してください。
-If you wish to allow users (e.g. "http") to put documents in the consumption folder, add them to the {{ic|paperless}} [[user group]].
-=== OCR languages ===
+=== OCR 言語 ===
+Paperless で英語以外の言語の文書を処理したい場合、対応する tesseract 言語データパッケージをインストールする必要があります。ドイツ語の場合は {{pkg|tesseract-data-deu}} がそれに該当します。
-If you want Paperless to consume documents in a language other than English, you need to install the corresponding tesseract language data package. For German that would be {{pkg|tesseract-data-deu}}.
+=== 生成された PDF 文書のサイズを減らす ===
-=== Reduce the size of generated PDF documents ===
+生成された PDF 文書のサイズを減らすために、オプションの依存関係 {{AUR|jbig2enc-git}} をインストールすることができます。これにより Paperless は PDF のサイズを小さくすることが可能です。
-You might want to install the optional dependency {{AUR|jbig2enc-git}} so Paperless can use it to reduce the size of generated PDF documents.
-=== Migrating from Paperless-ng ===
+=== Paperless-ng からの移行 ===
-If you have ''paperless-ng'' installed and wish to migrate to {{AUR|paperless-ngx}}, you can install {{AUR|paperless-ngx}} and choose to remove ''paperless-ng'' when asked. No data will be lost. Still, you will need to run as root:
+もし ''paperless-ng'' がインストールされており、{{AUR|paperless-ngx}} に移行したい場合、{{AUR|paperless-ngx}} をインストールし、尋ねられた際に ''paperless-ng'' を削除することを選択できます。データは失われません。それでも、root として次のコマンドを実行する必要があります：
  # paperless-manage makemigrations
+その後、paperless ユーザーとして通常のデータベースマイグレーションを適用します：
-After that, apply the usual database migrations as the paperless user:
  [paperless]$ paperless-manage migrate
-Finally, [[restart]] {{ic|paperless.target}}.
+最後に、{{ic|paperless.target}} を[[再起動]]してください。
-== Start ==
+== 開始 ==
-[[Start/enable]] {{ic|paperless.target}}.
+{{ic|paperless.target}} を[[開始/有効化]]してください。
+これで、Paperless インスタンスはポート 8000 で利用可能になるはずです。
-Your Paperless instance should now be available at port 8000.
-== Configuration ==
+== 設定 ==
+Paperless の設定の詳細については、その公式ドキュメントを参照してください。設定ファイルは {{ic|/etc/paperless.conf}} にあります。
-For details on Paperless configuration, visit its official [https://docs.paperless-ngx.com/configuration/ documentation]. The configuration file is located at {{ic|/etc/paperless.conf}}.
-{{Note|The {{AUR|paperless-ngx}} package creates a {{ic|paperless}} system user and provides a {{ic|paperless-manage}} command which should always be run as the {{ic|paperless}} user. See [[#Create admin user|below]] for an example. The {{ic|paperless-manage}} command should be used wherever the official documentation refers to {{ic|python3 manage.py}}.}}
+{{Note|{{AUR|paperless-ngx}} パッケージは {{ic|paperless}} システムユーザーを作成し、常に {{ic|paperless}} ユーザーとして実行されるべき {{ic|paperless-manage}} コマンドを提供しています。例については [[#Create admin user|以下]] を参照してください。公式ドキュメントで {{ic|python3 manage.py}} と言及されている場所ではいつも {{ic|paperless-manage}} コマンドを使用してください。}}
-Do not forget to [[restart]] {{ic|paperless.target}} after changing configurations.
+設定を変更した後は、{{ic|paperless.target}} を[[再起動]]するのを忘れないでください。
+=== 設定をニーズに合わせて調整 ===
-=== Adjust the configuration to your needs ===
+{{ic|/etc/paperless.conf}} にある設定ファイルを開き、特に OCR に関するパラメーターを含む、あなたのニーズに合わせてパラメーターを調整してください。個々の設定の説明については、公式ドキュメントを参照してください。
-Open the configuration file located at {{ic|/etc/paperless.conf}} at adjust the parameters to your needs, especially those concerning OCR. For explanations of the individual settings, refer to the official [https://docs.paperless-ngx.com/configuration/ documentation].
+=== シークレットキーの設定 ===
-=== Set a secret key ===
+初回インストール後、シークレットキーを生成して設定する必要があります。覚えておく必要はありませんが、署名付きデータのセキュリティに使用されるため、秘密にしておくべきです。シークレットキーを設定するには、以下の行のコメントを外して変更してください：
-After initial installation, you should generate and set a secret key. You do not need to remember it, but since it is used for securing signed data, you should keep it secret. To set a secret key, uncomment and modify the following line:
 {{hc|/etc/paperless.conf|2=
@@ 61行目: / 61行目: @@
 }}
+キーを生成して設定ファイルに設定するには、次のコマンドを実行します：
-To generate a key and set it in the configuration file, you can simply run the following command:
  # sed -i /etc/paperless.conf -e "s|#PAPERLESS_SECRET_KEY=change-me|PAPERLESS_SECRET_KEY=$(date | md5sum | awk '{print $1;}')|"
+=== データベースマイグレーションの実行 ===
-=== Run database migrations ===
+初回インストール後およびアップデート後には、データベースマイグレーションを実行する必要があります：
-After initial installation and after updates, you should run the database migrations:
  [paperless]$ paperless-manage migrate
-=== Create admin user ===
+=== 管理ユーザーの作成 ===
+初回インストール後、Paperless インスタンスの管理ユーザーを作成する必要があります：
-After initial installation, you should create an admin user for your Paperless instance:
  [paperless]$ paperless-manage createsuperuser
@@ 79行目: / 79行目: @@
 === Nginx ===
+[[Nginx]] をインストールし、Paperless のバーチャルホストのための以下の設定を起点として使用してください：
-Install [[Nginx]] and use the following configuration as a starting point for the Paperless virtual host:
 {{hc|/etc/nginx/sites-available/paperless.domain.tld|2=
@@ 108行目: / 108行目: @@
 }}
-=== Pacman hook ===
+=== Pacman フック ===
+パッケージの更新時に Paperless データベースのマイグレーションを自動的に実行するために、含まれている [[pacman フック]] を利用できます：
-To automatically run migrations for the Paperless database on package updates, you can make use of the included [[pacman hook]]:
  # mkdir -vp /etc/pacman.d/hooks
  # ln -sv /usr/share/paperless/docs/paperless.hook /etc/pacman.d/hooks/
+== トラブルシューティング ==
-== Troubleshooting ==
-=== BadSignature errors logged when trying to import documents ===
+=== 文書のインポート時に BadSignature エラーが記録される ===
-If you see {{ic|BadSignature}} errors when trying to import documents, it is likely that your configuration file located at {{ic|/etc/paperless.conf}} is not taken into account because the template configuration file {{ic|/usr/share/paperless/paperless.conf}} is given precedence. In that case, remove or rename {{ic|/usr/share/paperless/paperless.conf}} and [[restart]] {{ic|paperless.target}}.
+文書のインポートを試みた際に {{ic|BadSignature}} エラーが出る場合、{{ic|/etc/paperless.conf}} にある設定ファイルが考慮されていない可能性が高いです。これは、テンプレートの設定ファイル {{ic|/usr/share/paperless/paperless.conf}} が優先されているためです。この場合、{{ic|/usr/share/paperless/paperless.conf}} を削除または名前を変更し、{{ic|paperless.target}} を [[restart]] してください。
+=== 誤設定されたリトライとタイムアウトに関する警告 ===
-=== Warning about misconfigured retry and timeout ===
-If you see a warning about misconfigured retry and timeout, you can [https://github.com/jonaswinkler/paperless-ng/issues/857 safely ignore] it and wait for the [https://github.com/Koed00/django-q/issues/526 simple upstream fix] in {{pkg|python-django-q}}. The warning would look like this:
+リトライとタイムアウトが誤設定されているという警告が出る場合、それは [https://github.com/jonaswinkler/paperless-ng/issues/857 安全に無視できます] し、{{pkg|python-django-q}} における [https://github.com/Koed00/django-q/issues/526 シンプルなアップストリームの修正] を待つことができます。警告は以下のように表示されるでしょう：
 {{bc|<nowiki>
@@ 132行目: / 132行目: @@
 </nowiki>}}
-=== Thumbnail generation with ImageMagick fails ===
+=== ImageMagick でのサムネイル生成が失敗する ===
-You have to disable a policy rule in {{ic|/etc/ImageMagick-7/policy.xml}}. Add {{ic|<nowiki><!--</nowiki>}} and {{ic|<nowiki>--></nowiki>}} to comment out the following line:
+{{ic|/etc/ImageMagick-7/policy.xml}} でポリシールールを無効にする必要があります。次の行をコメントアウトするために {{ic|<nowiki><!--</nowiki>}} と {{ic|<nowiki>--></nowiki>}} を追加してください：
 {{hc|/etc/ImageMagick-7/policy.xml|2=<nowiki>
@@ 140行目: / 140行目: @@
 </nowiki>}}
+[[ImageMagick]] 記事の冒頭で述べられている可能性のあるセキュリティ上の影響を考慮してください。また、ImageMagick のポリシールールが有効なままの場合、Paperless はとにかく ghostscript を使用するようにフォールバックすることも覚えておいてください。
-Consider the possible security implications noted at the beginning of the [[ImageMagick]] article. Also note that Paperless will fall back to using ghostscript anyway if the ImageMagick policy rule stays active.
+=== コンシューマーサービスが常に 1 つの CPU コアを 100% で使用する ===
-=== The consumer service keeps one CPU core constantly at 100% ===
+{{ic|/etc/paperless.conf}} 設定ファイルの {{ic|PAPERLESS_CONSUMER_POLLING}} 設定に関する行のコメントを解除してください：
-Uncomment the line concerning the {{ic|PAPERLESS_CONSUMER_POLLING}} setting in your {{ic|/etc/paperless.conf}} configuration file:
 {{hc|/etc/paperless.conf|2=<nowiki>
 PAPERLESS_CONSUMER_POLLING=10
 </nowiki>}}
+{{TranslationStatus|Paperless|2024/04/12|792146}}