paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update Tika documentation

Browse Source
This commit is contained in:
Quinn Casey 2022-05-02 09:02:29 -07:00
parent a938895e5e
commit d58b1a7de7
5 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docker/compose/docker-compose.postgres-tika.yml
View File

@ -1,7 +1,6 @@
# docker-compose file for running paperless from the docker container registry. # docker-compose file for running paperless from the docker container registry.
# This file contains everything paperless needs to run. # This file contains everything paperless needs to run.
# Paperless supports amd64, arm and arm64 hardware. The apache/tika image # Paperless supports amd64, arm and arm64 hardware.
# does not support arm or arm64, however.
# #
# All compose files of paperless configure paperless in the following way: # All compose files of paperless configure paperless in the following way:
# #

4
docker/compose/docker-compose.sqlite-tika.yml
View File

@ -1,8 +1,6 @@
# docker-compose file for running paperless from the docker container registry. # docker-compose file for running paperless from the docker container registry.
# This file contains everything paperless needs to run. # This file contains everything paperless needs to run.
# Paperless supports amd64, arm and arm64 hardware. The apache/tika image # Paperless supports amd64, arm and arm64 hardware.
# does not support arm or arm64, however.
#
# All compose files of paperless configure paperless in the following way: # All compose files of paperless configure paperless in the following way:
# #
# - Paperless is (re)started on system boot, if it was running before shutdown. # - Paperless is (re)started on system boot, if it was running before shutdown.

4
docs/configuration.rst
View File

@ -474,7 +474,7 @@ PAPERLESS_TIKA_GOTENBERG_ENDPOINT=<url>
Defaults to "http://localhost:3000". Defaults to "http://localhost:3000".
If you run paperless on docker, you can add those services to the docker-compose If you run paperless on docker, you can add those services to the docker-compose
file (see the provided ``docker-compose.tika.yml`` file for reference). The changes file (see the provided ``docker-compose.sqlite-tika.yml`` file for reference). The changes
requires are as follows: requires are as follows:
.. code:: yaml .. code:: yaml
@ -502,7 +502,7 @@ requires are as follows:
- "--chromium-disable-routes=true" - "--chromium-disable-routes=true"
tika: tika:
image: apache/tika image: ghcr.io/paperless-ngx/tika:latest
restart: unless-stopped restart: unless-stopped
Add the configuration variables to the environment of the webserver (alternatively Add the configuration variables to the environment of the webserver (alternatively

4
docs/setup.rst
View File

@ -347,7 +347,7 @@ writing. Windows is not and will never be supported.
paperless stores its data. If you like, you can point both to the same directory. paperless stores its data. If you like, you can point both to the same directory.
* ``PAPERLESS_SECRET_KEY`` should be a random sequence of characters. It's used for authentication. Failure * ``PAPERLESS_SECRET_KEY`` should be a random sequence of characters. It's used for authentication. Failure
to do so allows third parties to forge authentication credentials. to do so allows third parties to forge authentication credentials.
* ``PAPERLESS_URL`` if you are behind a reverse proxy. This should point to your domain. Please see * ``PAPERLESS_URL`` if you are behind a reverse proxy. This should point to your domain. Please see
:ref:`configuration` for more information. :ref:`configuration` for more information.
Many more adjustments can be made to paperless, especially the OCR part. The following options are recommended Many more adjustments can be made to paperless, especially the OCR part. The following options are recommended
@ -728,8 +728,6 @@ configuring some options in paperless can help improve performance immensely:
times. Thumbnails will be about 20% larger. times. Thumbnails will be about 20% larger.
* If using docker, consider setting ``PAPERLESS_WEBSERVER_WORKERS`` to * If using docker, consider setting ``PAPERLESS_WEBSERVER_WORKERS`` to
1. This will save some memory. 1. This will save some memory.
* Use the arm compatible docker-compose if you're wanting to use Tika on something like
a raspberry pi. The official apache/tika image does not support the arm architecture.
For details, refer to :ref:`configuration`. For details, refer to :ref:`configuration`.

2
scripts/start_services.sh
View File

@ -3,4 +3,4 @@
docker run -p 5432:5432 -e POSTGRES_PASSWORD=password -v paperless_pgdata:/var/lib/postgresql/data -d postgres:13 docker run -p 5432:5432 -e POSTGRES_PASSWORD=password -v paperless_pgdata:/var/lib/postgresql/data -d postgres:13
docker run -d -p 6379:6379 redis:latest docker run -d -p 6379:6379 redis:latest
docker run -p 3000:3000 -d gotenberg/gotenberg:7 docker run -p 3000:3000 -d gotenberg/gotenberg:7
docker run -p 9998:9998 -d apache/tika docker run -p 9998:9998 -d ghcr.io/paperless-ngx/tika:latest