mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 03:16:10 -06:00 
			
		
		
		
	Documentation: copy-edits (#10417)
This commit is contained in:
		@@ -306,7 +306,7 @@ in dedicated folders according to their nature: `archive`, `originals`,
 | 
			
		||||
If `-sm` or `--split-manifest` is provided, information about document
 | 
			
		||||
will be placed in individual json files, instead of a single JSON file. The main
 | 
			
		||||
manifest.json will still contain application wide information (e.g. tags, correspondent,
 | 
			
		||||
documenttype, etc)
 | 
			
		||||
document type, etc)
 | 
			
		||||
 | 
			
		||||
If `-z` or `--zip` is provided, the export will be a zip file
 | 
			
		||||
in the target directory, named according to the current local date or the
 | 
			
		||||
 
 | 
			
		||||
@@ -95,13 +95,13 @@ first-time setup.
 | 
			
		||||
 | 
			
		||||
7.  You can now either ...
 | 
			
		||||
 | 
			
		||||
    -   install redis or
 | 
			
		||||
    -   install Redis or
 | 
			
		||||
 | 
			
		||||
    -   use the included `scripts/start_services.sh` to use docker to fire
 | 
			
		||||
        up a redis instance (and some other services such as tika,
 | 
			
		||||
        gotenberg and a database server) or
 | 
			
		||||
    -   use the included `scripts/start_services.sh` to use Docker to fire
 | 
			
		||||
        up a Redis instance (and some other services such as Tika,
 | 
			
		||||
        Gotenberg and a database server) or
 | 
			
		||||
 | 
			
		||||
    -   spin up a bare redis container
 | 
			
		||||
    -   spin up a bare Redis container
 | 
			
		||||
 | 
			
		||||
        ```
 | 
			
		||||
        docker run -d -p 6379:6379 --restart unless-stopped redis:latest
 | 
			
		||||
@@ -147,7 +147,7 @@ $ ng build --configuration production
 | 
			
		||||
### Testing
 | 
			
		||||
 | 
			
		||||
-   Run `pytest` in the `src/` directory to execute all tests. This also
 | 
			
		||||
    generates a HTML coverage report. When runnings test, `paperless.conf`
 | 
			
		||||
    generates a HTML coverage report. When running tests, `paperless.conf`
 | 
			
		||||
    is loaded as well. However, the tests rely on the default
 | 
			
		||||
    configuration. This is not ideal. But for now, make sure no settings
 | 
			
		||||
    except for DEBUG are overridden when testing.
 | 
			
		||||
 
 | 
			
		||||
@@ -30,7 +30,7 @@ physical documents into a searchable online archive so you can keep, well, _less
 | 
			
		||||
-   Utilizes the open-source Tesseract engine to recognize more than 100 languages.
 | 
			
		||||
-   Documents are saved as PDF/A format which is designed for long term storage, alongside the unaltered originals.
 | 
			
		||||
-   Uses machine-learning to automatically add tags, correspondents and document types to your documents.
 | 
			
		||||
-   Supports PDF documents, images, plain text files, Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents)[^1] and more.
 | 
			
		||||
-   Supports PDF documents, images, plain text files, Office documents (Word, Excel, PowerPoint, and LibreOffice equivalents)[^1] and more.
 | 
			
		||||
-   Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely with different configurations assigned to different documents.
 | 
			
		||||
-   **Beautiful, modern web application** that features:
 | 
			
		||||
    -   Customizable dashboard with statistics.
 | 
			
		||||
 
 | 
			
		||||
@@ -445,7 +445,7 @@ are released, dependency support is confirmed, etc.
 | 
			
		||||
13. Configure ImageMagick to allow processing of PDF documents. Most
 | 
			
		||||
    distributions have this disabled by default, since PDF documents can
 | 
			
		||||
    contain malware. If you don't do this, paperless will fall back to
 | 
			
		||||
    ghostscript for certain steps such as thumbnail generation.
 | 
			
		||||
    Ghostscript for certain steps such as thumbnail generation.
 | 
			
		||||
 | 
			
		||||
    Edit `/etc/ImageMagick-6/policy.xml` and adjust
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -335,7 +335,7 @@ You may see errors when deleting documents like:
 | 
			
		||||
Data too long for column 'transaction_id' at row 1
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
This error can occur in installations which have upgraded from a version of Paperless-ngx that used Django 4 (Paperless-ngx versions prior to v2.13.0) with a MariaDB/MySQL database. Due to the backawards-incompatible change in Django 5, the column "documents_document.transaction_id" will need to be re-created, which can be done with a one-time run of the following management command:
 | 
			
		||||
This error can occur in installations which have upgraded from a version of Paperless-ngx that used Django 4 (Paperless-ngx versions prior to v2.13.0) with a MariaDB/MySQL database. Due to the backwards-incompatible change in Django 5, the column "documents_document.transaction_id" will need to be re-created, which can be done with a one-time run of the following management command:
 | 
			
		||||
 | 
			
		||||
```shell-session
 | 
			
		||||
$ python3 manage.py convert_mariadb_uuid
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user