documentation

docs/faq.rst

@@ -62,9 +62,9 @@ file extensions do not matter.
 
 **A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B.
 The long answer is that certain parts of
-Paperless will run very slow, such as the tesseract OCR. On Raspberry Pi,
+Paperless will run very slow, such as the OCR. On Raspberry Pi,
 try to OCR documents before feeding them into paperless so that paperless can
-reuse the text. The web interface should be a lot snappier, since it runs
+reuse the text. The web interface is a lot snappier, since it runs
 in your browser and paperless has to do much less work to serve the data.
 
 .. note::
@@ -76,7 +76,14 @@ in your browser and paperless has to do much less work to serve the data.
 **Q:** *How do I install paperless-ng on Raspberry Pi?*
 
 **A:** Docker images are available for arm and arm64 hardware, so just follow
-the docker-compose instructions, or go the bare metal route.
+the docker-compose instructions. Apart from more required disk space compared to
+a bare metal installation, docker comes with close to zero overhead, even on
+Raspberry Pi.
+
+If you decide to got with the bare metal route, be aware that some of the
+python requirements do not have precompiled packages for ARM / ARM64. Installation
+of these will require additional development libraries and compilation will take
+a long time.
 
 **Q:** *How do I run this on unRaid?*
 
@@ -95,12 +102,21 @@ occasionally build the image on and see if it works.
 
 **Q:** *How do I proxy this with NGINX?*
 
-.. code::
+**A:** See :ref:`here <setup-nginx>`.
 
-    location / {
-        proxy_pass http://localhost:8000/
-    }
+.. _faq-mod_wsgi:
 
-And that's about it. Paperless serves everything, including static files by itself
-when running the docker image. If you want to do anything fancy, you have to
-install paperless bare metal.
+**Q:** *How do I get WebSocket support with Apache mod_wsgi*?
+
+**A:** ``mod_wsgi`` by itself does not support ASGI. Paperless will continue
+to work with WSGI, but certain features such as status notifications about
+document consumption won't be available.
+
+If you want to continue using ``mod_wsgi``, you will have to run an ASGI-enabled
+web server as well that processes WebSocket connections, and configure Apache to
+redirect WebSocket connections to this server. Multiple options for ASGI servers
+exist:
+
+* ``gunicorn`` with ``uvicorn`` as the worker implementation (the default of paperless)
+* ``daphne`` as a standalone server, which is the reference implementation for ASGI.
+* ``uvicorn`` as a standalone server