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

documentation #444

Browse Source
This commit is contained in:
jonaswinkler 2021-01-26 19:32:09 +01:00
parent 277bf0eb83
commit 944aaf5438
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/setup.rst
View File

@ -98,10 +98,11 @@ The ansible route combines benefits of both options:
the setup process is fully automated, reproducible and `idempotent <https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency>`_, the setup process is fully automated, reproducible and `idempotent <https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency>`_,
it includes the same sensible defaults, and it simultaneously provides the flexibility of a bare metal installation. it includes the same sensible defaults, and it simultaneously provides the flexibility of a bare metal installation.
.. _setup-docker_hub:
.. _CLI Basics: https://sehn.tech/post/devops-with-docker/ .. _CLI Basics: https://sehn.tech/post/devops-with-docker/
.. _idempotent: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency .. _idempotent: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency
.. _setup-docker_hub:
Install Paperless from Docker Hub Install Paperless from Docker Hub
================================= =================================
@ -131,7 +132,7 @@ Install Paperless from Docker Hub
See the `Docker installation guide`_ on how to install the current See the `Docker installation guide`_ on how to install the current
version of Docker for your operating system or Linux distribution of version of Docker for your operating system or Linux distribution of
choice. To get the latest version of docker-compose, follow the choice. To get the latest version of docker-compose, follow the
`docker-compose installation guide`_if your package repository doesn't `docker-compose installation guide`_ if your package repository doesn't
include it. include it.
.. _Docker installation guide: https://docs.docker.com/engine/installation/ .. _Docker installation guide: https://docs.docker.com/engine/installation/
@ -348,7 +349,8 @@ writing. Windows is not and will never be supported.
.. warning:: .. warning::
This is a development server which should not be used in This is a development server which should not be used in
production. production. It is not audited for security and performance
is inferior to production ready web servers.
.. hint:: .. hint::
@ -363,6 +365,11 @@ writing. Windows is not and will never be supported.
``consumer`` script to watch the input folder, and the ``scheduler`` ``consumer`` script to watch the input folder, and the ``scheduler``
script to run tasks such as email checking and document consumption. script to run tasks such as email checking and document consumption.
You may need to adjust the path to the ``gunicorn`` executable. This
will be installed as part of the python dependencies, and is either located
in the ``bin`` folder of your virtual environment, or in ``~/.local/bin/`` if
no virtual environment is used.
These services rely on redis and optionally the database server, but These services rely on redis and optionally the database server, but
don't need to be started in any particular order. The example files don't need to be started in any particular order. The example files
depend on redis being started. If you use a database server, you should depend on redis being started. If you use a database server, you should