ステータス	イベント
	週間スケジュール
	最後のプルリクエスト

Ansible ロール: paperless_ngx

paperless-ngx EDMS をインストールおよび設定します。

1. 要件

1.1. Ansible

ansible_version_minimum: "2.12" 以上が必要です。

次の Ansible コレクションをインストールする必要があります（ansible-galaxy collection install を使用）

• community.general
• ansible.posix

1.2. サポートされているオペレーティングシステム

• Debian (>=11)
• Ubuntu (>=focal)

2. ロール変数

paperless-ngx からのほとんどの設定変数は利用可能で、各引数を受け入れます。すべての PAPERLESS_* 設定変数は小文字に変換され、defaults/main.yml では paperless_ngx_conf_* という接頭辞が付けられます。

現在の ドキュメント で、説明と許可された値を含む完全なリストをご覧ください。

以下のセクションは次のように分かれています：

• ロール固有の変数
• 元の paperless-ngx 設定変数

2.1. ロール固有の変数

名前	デフォルト値	説明
paperless_ngx_db_type	sqlite	利用可能なデータベースタイプは sqlite と postgresql です。postgresql を選択した場合、他の db_ 変数も設定する必要があります。
paperless_ngx_dependency_install_tmp_dir	/tmp/	一時依存関係インストールファイルのディレクトリ
paperless_ngx_dir_installation	/opt/paperless-ngx	paperless-ngx の静的インストールファイルが書き込まれるディレクトリ
paperless_ngx_redis_host	localhost	Redis ホスト
paperless_ngx_version	latest	インストールするソフトウェアのバージョン。latest または '2.0.0' の形式で任意の特定のバージョンを使用できます。

2.2. Paperless-ngx 設定変数

今後の変数は paperless-ngx ドキュメント の変数に対応しています。このリストはメンテナンスを容易にするためにアルファベット順に並べられています。

名前	デフォルト値	実装	上書き可能	ヒント	バージョン
paperless_ngx_conf_admin_email	root@localhost	Y	Y
paperless_ngx_conf_admin_password		Y	Y	スーパーユーザーのパスワード。ユーザーによって指定されていない場合は、ランダムなパスワードが生成されます。
paperless_ngx_conf_dbname	paperlessngx	Y	Y
paperless_ngx_conf_port	8000	Y	Y

3. 使用アドバイス

3.1. Paperless-ngx の更新

このロールを使用して Paperless-ngx をインストールした場合、最新のバージョンに更新するには、このロールを再度実行するだけです（バージョン識別子として latest を選択した場合）。特定のバージョンを指定した場合は、その値を新しいものに変更し、ロールを再度実行するだけです。

このロールは Paperless-ngx 以外のものを更新しませんので、オペレーティングシステムや依存パッケージの更新は別途対応が必要です。

アップグレード前にバックアップを検討してください。

3.2. バックアップ/復元

このロールはバックアップや復元のメカニズムを提供していないことに注意してください。このロールは、ソフトウェアアーティファクトやその設定の「デプロイメント」にのみフォーカスしています。動作するバックアップ戦略の例は以下で見つけることができます：バックアップ戦略の例へのリンク

3.3. 生成されたパスワード

このロールでは、Ansible のパスワードルックアップを使用します。

• パスワードが生成されると、ansible はそれを ローカル に pngx_instances/{{ inventory_hostname }}/ に保存します（作業ディレクトリに対して相対的に）
• ファイルがすでに存在する場合、その内容を再利用します。

3.4. 静的（インストール）データと動的（ランタイム）データの分離

このロールは、データディレクトリ（消費など）をインストールパスのサブディレクトリとして設定しないことをチェックします。 このロールは、アップグレード時にインストールフォルダを削除し、新しいものを作成します。これにより、データの不要な削除を防ぎます。

3.5. PostgreSQL の使用

Paperless-ngx を PostgreSQL と一緒に使用したい場合は、実行中の PostgreSQL インスタンスが必要です。このロールは自動的にデータベースインスタンスをインストールしません。しかし、こちらでゼロからのインスタンスの設定例を読むことができます：インスタンス設定の例へのリンク

4. 依存関係

依存関係はありません

5. 例プレイブック

minimal_runnable_playbook.yml:

- hosts: all
    roles:
        - { role: paperless_ngx.paperless_ngx }
    vars:
        var1:
        var2:
        ...

6. 貢献

このロールへの貢献を歓迎します！貢献する際の手順については、貢献ガイド をご覧ください。

7. ライセンス

MIT