From 944aaf54383bfa648f3cbeb6d9ffb4eb9528715c Mon Sep 17 00:00:00 2001 From: jonaswinkler Date: Tue, 26 Jan 2021 19:32:09 +0100 Subject: [PATCH] documentation #444 --- docs/setup.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/setup.rst b/docs/setup.rst index 73af557e7..574631a58 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -98,10 +98,11 @@ The ansible route combines benefits of both options: the setup process is fully automated, reproducible and `idempotent `_, 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/ .. _idempotent: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency +.. _setup-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 version of Docker for your operating system or Linux distribution of 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. .. _Docker installation guide: https://docs.docker.com/engine/installation/ @@ -348,7 +349,8 @@ writing. Windows is not and will never be supported. .. warning:: 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:: @@ -363,6 +365,11 @@ writing. Windows is not and will never be supported. ``consumer`` script to watch the input folder, and the ``scheduler`` 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 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