Paperlessのソースを表示

[[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.

== Installation ==

[[Install]] the {{AUR|paperless-ngx}} package.

=== 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.
The {{ic|consume}} folder has write permissions for everyone in the {{ic|paperless}} group.

=== Consumption folder permissions ===

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 ===

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}}.

=== Reduce the size of generated PDF documents ===

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 ===

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-manage makemigrations

After that, apply the usual database migrations as the paperless user:

 [paperless]$ paperless-manage migrate

Finally, [[restart]] {{ic|paperless.target}}.

== Start ==

[[Start/enable]] {{ic|paperless.target}}. 
Your Paperless instance should now be available at port 8000.

== Configuration ==

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}}.}}

Do not forget to [[restart]] {{ic|paperless.target}} after changing configurations.

=== Adjust the configuration to your needs ===

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=
#PAPERLESS_SECRET_KEY=change-me
}}

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 ===

After initial installation, you should create an admin user for your Paperless instance:

 [paperless]$ paperless-manage createsuperuser

=== Nginx ===

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=
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 hook ===

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 ===

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}}.

=== 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:

{{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>}}

=== Thumbnail generation with ImageMagick fails ===

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:

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

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.

=== The consumer service keeps one CPU core constantly at 100% ===

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>}}