Paperlessのソースを表示

[[Category:サーバー]]
[[en:Paperless]]
[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 プロジェクトのフォークであり、両方とも放棄されています。

== インストール ==

{{AUR|paperless-ngx}} パッケージを[[インストール]]します。

=== フォルダ ===

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}} グループのすべてのユーザーに対して書き込み権限があります。

=== 消費フォルダの権限 ===

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

=== OCR 言語 ===

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

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

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

=== Paperless-ng からの移行 ===

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

 # paperless-manage makemigrations

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

 [paperless]$ paperless-manage migrate

最後に、{{ic|paperless.target}} を[[再起動]]してください。

== 開始 ==

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

== 設定 ==

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

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

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

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

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

=== シークレットキーの設定 ===

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

{{hc|/etc/paperless.conf|2=
#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 のバーチャルホストのための以下の設定を起点として使用してください：

{{hc|/etc/nginx/sites-available/paperless.domain.tld|2=
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 エラーが記録される ===

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

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

リトライとタイムアウトが誤設定されているという警告が出る場合、それは [https://github.com/jonaswinkler/paperless-ng/issues/857 安全に無視できます] し、{{pkg|python-django-q}} における [https://github.com/Koed00/django-q/issues/526 シンプルなアップストリームの修正] を待つことができます。警告は以下のように表示されるでしょう：

{{bc|<nowiki>
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,
</nowiki>}}

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

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

{{hc|/etc/ImageMagick-7/policy.xml|2=<nowiki>
<!-- <policy domain="delegate" rights="none" pattern="gs" /> -->
</nowiki>}}

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

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

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

{{hc|/etc/paperless.conf|2=<nowiki>
PAPERLESS_CONSUMER_POLLING=10
</nowiki>}}

{{TranslationStatus|Paperless|2024/04/12|792146}}