mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 03:16:10 -06:00 
			
		
		
		
	a couple changes to the documentation
This commit is contained in:
		@@ -25,8 +25,9 @@ This section describes the steps you need to take to start development on paperl
 | 
			
		||||
 | 
			
		||||
    *   Python 3.6.
 | 
			
		||||
    *   All dependencies listed in the :ref:`Bare metal route <setup-bare_metal>`
 | 
			
		||||
    *   redis. You can either install redis or use the included scritps/start-redis.sh
 | 
			
		||||
        to use docker to fire up a redis instance.
 | 
			
		||||
    *   redis. You can either install redis or use the included scritps/start-services.sh
 | 
			
		||||
        to use docker to fire up a redis instance (and some other services such as tika,
 | 
			
		||||
        gotenberg and a postgresql server).
 | 
			
		||||
 | 
			
		||||
Back end development
 | 
			
		||||
====================
 | 
			
		||||
@@ -38,7 +39,7 @@ Install the python dependencies by performing ``pipenv install --dev`` in the sr
 | 
			
		||||
This will also create a virtual environment, which you can enter with ``pipenv shell`` or
 | 
			
		||||
execute one-shot commands in with ``pipenv run``.
 | 
			
		||||
 | 
			
		||||
In ``src/paperless.conf``, enable debug mode.
 | 
			
		||||
Copy ``paperless.conf.example`` to ``paperless.conf`` and enable debug mode.
 | 
			
		||||
 | 
			
		||||
Configure the IDE to use the src/ folder as the base source folder. Configure the following
 | 
			
		||||
launch configurations in your IDE:
 | 
			
		||||
@@ -102,18 +103,11 @@ In order to build the front end and serve it as part of django, execute
 | 
			
		||||
 | 
			
		||||
.. code:: shell-session
 | 
			
		||||
 | 
			
		||||
    $ ng build --prod --output-path ../src/documents/static/frontend/
 | 
			
		||||
    $ ng build --prod
 | 
			
		||||
 | 
			
		||||
This will build the front end and put it in a location from which the Django server will serve
 | 
			
		||||
it as static content. This way, you can verify that authentication is working.
 | 
			
		||||
 | 
			
		||||
Making a release
 | 
			
		||||
================
 | 
			
		||||
 | 
			
		||||
Execute the ``make-release.sh <ver>`` script.
 | 
			
		||||
 | 
			
		||||
This will test and assemble everything and also build and tag a docker image.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Extending Paperless
 | 
			
		||||
===================
 | 
			
		||||
 
 | 
			
		||||
@@ -52,6 +52,8 @@ out of that folder to use them elsewhere. Here are a couple notes about that.
 | 
			
		||||
*   PDF documents, PNG images, JPEG images, TIFF images and GIF images are processed with OCR and converted into PDF documents.
 | 
			
		||||
*   Plain text documents are supported as well and are added verbatim
 | 
			
		||||
    to paperless.
 | 
			
		||||
*   With the optional Tika integration enabled (see :ref:`Configuration <configuration-tika>`), Paperless also supports various
 | 
			
		||||
    Office documents (.docx, .doc, odt, .ppt, .pptx, .odp, .xls, .xlsx, .ods).
 | 
			
		||||
 | 
			
		||||
Paperless determines the type of a file by inspecting its content. The
 | 
			
		||||
file extensions do not matter.
 | 
			
		||||
@@ -73,10 +75,8 @@ 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:** There is no docker image for ARM available. If you know how to build
 | 
			
		||||
that automatically, I'm all ears. For now, you have to grab the latest release
 | 
			
		||||
archive from the project page and build the image yourself. The release comes
 | 
			
		||||
with the front end already compiled, so you don't have to do this on the Pi.
 | 
			
		||||
**A:** Docker images are available for arm and arm64 hardware, so just follow
 | 
			
		||||
the docker-compose instructions, or go the bare metal route.
 | 
			
		||||
 | 
			
		||||
**Q:** *How do I run this on unRaid?*
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -232,8 +232,9 @@ writing. Windows is not and will never be supported.
 | 
			
		||||
    *   ``optipng`` for optimizing thumbnails
 | 
			
		||||
    *   ``gnupg`` for handling encrypted documents
 | 
			
		||||
    *   ``libpoppler-cpp-dev`` for PDF to text conversion
 | 
			
		||||
    *   ``libmagic-dev`` for mime type detection
 | 
			
		||||
    *   ``libpq-dev`` for PostgreSQL
 | 
			
		||||
    *   ``libmagic-dev`` for mime type detection
 | 
			
		||||
    *   ``mime-support`` for mime type detection
 | 
			
		||||
 | 
			
		||||
    These dependencies are required for OCRmyPDF, which is used for text recognition.
 | 
			
		||||
 | 
			
		||||
@@ -248,6 +249,10 @@ writing. Windows is not and will never be supported.
 | 
			
		||||
    *   ``tesseract-ocr`` >= 4.0.0 for OCR
 | 
			
		||||
    *   ``tesseract-ocr`` language packs (``tesseract-ocr-eng``, ``tesseract-ocr-deu``, etc)
 | 
			
		||||
 | 
			
		||||
    On Raspberry Pi, these libraries are required as well:
 | 
			
		||||
 | 
			
		||||
    *   ``libatlas-base-dev``
 | 
			
		||||
 | 
			
		||||
    You will also need ``build-essential``, ``python3-setuptools`` and ``python3-wheel``
 | 
			
		||||
    for installing some of the python dependencies.
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user