mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 03:16:10 -06:00 
			
		
		
		
	Merge remote-tracking branch 'origin/dev'
This commit is contained in:
		@@ -34,7 +34,7 @@ Options available to docker installations:
 | 
			
		||||
    Paperless uses 4 volumes:
 | 
			
		||||
 | 
			
		||||
    -   `paperless_media`: This is where your documents are stored.
 | 
			
		||||
    -   `paperless_data`: This is where auxillary data is stored. This
 | 
			
		||||
    -   `paperless_data`: This is where auxiliary data is stored. This
 | 
			
		||||
        folder also contains the SQLite database, if you use it.
 | 
			
		||||
    -   `paperless_pgdata`: Exists only if you use PostgreSQL and
 | 
			
		||||
        contains the database.
 | 
			
		||||
@@ -408,7 +408,7 @@ that don't match a document anymore get removed as well.
 | 
			
		||||
### Managing the Automatic matching algorithm
 | 
			
		||||
 | 
			
		||||
The _Auto_ matching algorithm requires a trained neural network to work.
 | 
			
		||||
This network needs to be updated whenever somethings in your data
 | 
			
		||||
This network needs to be updated whenever something in your data
 | 
			
		||||
changes. The docker image takes care of that automatically with the task
 | 
			
		||||
scheduler. You can manually renew the classifier by invoking the
 | 
			
		||||
following management command:
 | 
			
		||||
@@ -597,7 +597,7 @@ This tool does a fuzzy match over document content, looking for
 | 
			
		||||
those which look close according to a given ratio.
 | 
			
		||||
 | 
			
		||||
At this time, other metadata (such as correspondent or type) is not
 | 
			
		||||
take into account by the detection.
 | 
			
		||||
taken into account by the detection.
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
document_fuzzy_match [--ratio] [--processes N]
 | 
			
		||||
 
 | 
			
		||||
@@ -510,7 +510,7 @@ existing tables) with:
 | 
			
		||||
 | 
			
		||||
## Barcodes {#barcodes}
 | 
			
		||||
 | 
			
		||||
Paperless is able to utilize barcodes for automatically preforming some tasks.
 | 
			
		||||
Paperless is able to utilize barcodes for automatically performing some tasks.
 | 
			
		||||
 | 
			
		||||
At this time, the library utilized for detection of barcodes supports the following types:
 | 
			
		||||
 | 
			
		||||
@@ -566,7 +566,7 @@ collating two separate scans into one document, reordering the pages as necessar
 | 
			
		||||
 | 
			
		||||
Suppose you have a double-sided document with 6 pages (3 sheets of paper). First,
 | 
			
		||||
put the stack into your ADF as normal, ensuring that page 1 is scanned first. Your ADF
 | 
			
		||||
will now scan pages 1, 3, and 5. Then you (or your the scanner, if it supports it) upload
 | 
			
		||||
will now scan pages 1, 3, and 5. Then you (or your scanner, if it supports it) upload
 | 
			
		||||
the scan into the correct sub-directory of the consume folder (`double-sided` by default;
 | 
			
		||||
keep in mind that Paperless will _not_ automatically create the directory for you.)
 | 
			
		||||
Paperless will then process the scan and move it into an internal staging area.
 | 
			
		||||
 
 | 
			
		||||
@@ -21,6 +21,7 @@ The API provides the following main endpoints:
 | 
			
		||||
- `/api/groups/`: Full CRUD support.
 | 
			
		||||
- `/api/share_links/`: Full CRUD support.
 | 
			
		||||
- `/api/custom_fields/`: Full CRUD support.
 | 
			
		||||
- `/api/profile/`: GET, PATCH
 | 
			
		||||
 | 
			
		||||
All of these endpoints except for the logging endpoint allow you to
 | 
			
		||||
fetch (and edit and delete where appropriate) individual objects by
 | 
			
		||||
@@ -157,6 +158,10 @@ The REST api provides three different forms of authentication.
 | 
			
		||||
 | 
			
		||||
3.  Token authentication
 | 
			
		||||
 | 
			
		||||
    You can create (or re-create) an API token by opening the "My Profile"
 | 
			
		||||
    link in the user dropdown found in the web UI and clicking the circular
 | 
			
		||||
    arrow button.
 | 
			
		||||
 | 
			
		||||
    Paperless also offers an endpoint to acquire authentication tokens.
 | 
			
		||||
 | 
			
		||||
    POST a username and password as a form or json string to
 | 
			
		||||
@@ -168,7 +173,7 @@ The REST api provides three different forms of authentication.
 | 
			
		||||
    Authorization: Token <token>
 | 
			
		||||
    ```
 | 
			
		||||
 | 
			
		||||
    Tokens can be managed and revoked in the paperless admin.
 | 
			
		||||
    Tokens can also be managed in the Django admin.
 | 
			
		||||
 | 
			
		||||
## Searching for documents
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -2,6 +2,10 @@
 | 
			
		||||
 | 
			
		||||
## paperless-ngx 2.0.1
 | 
			
		||||
 | 
			
		||||
### Please Note
 | 
			
		||||
 | 
			
		||||
Exports generated in Paperless-ngx v2.0.0–2.0.1 will **not** contain consumption templates or custom fields, we recommend users upgrade to at least v2.1.
 | 
			
		||||
 | 
			
		||||
### Bug Fixes
 | 
			
		||||
 | 
			
		||||
- Fix: Increase field the length for consumption template source [@stumpylog](https://github.com/stumpylog) ([#4719](https://github.com/paperless-ngx/paperless-ngx/pull/4719))
 | 
			
		||||
@@ -22,6 +26,10 @@
 | 
			
		||||
 | 
			
		||||
## paperless-ngx 2.0.0
 | 
			
		||||
 | 
			
		||||
### Please Note
 | 
			
		||||
 | 
			
		||||
Exports generated in Paperless-ngx v2.0.0–2.0.1 will **not** contain consumption templates or custom fields, we recommend users upgrade to at least v2.1.
 | 
			
		||||
 | 
			
		||||
### Breaking Changes
 | 
			
		||||
 | 
			
		||||
- Breaking: Rename the environment variable for self-signed email certificates [@stumpylog](https://github.com/stumpylog) ([#4346](https://github.com/paperless-ngx/paperless-ngx/pull/4346))
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,7 @@ following way:
 | 
			
		||||
- `main` always represents the latest release and will only see
 | 
			
		||||
  changes when a new release is made.
 | 
			
		||||
- `dev` contains the code that will be in the next release.
 | 
			
		||||
- `feature-X` contain bigger changes that will be in some release, but
 | 
			
		||||
- `feature-X` contains bigger changes that will be in some release, but
 | 
			
		||||
  not necessarily the next one.
 | 
			
		||||
 | 
			
		||||
When making functional changes to Paperless-ngx, _always_ make your changes
 | 
			
		||||
 
 | 
			
		||||
@@ -87,7 +87,7 @@ follow the [Docker Compose instructions](https://docs.paperless-ngx.com/setup/#i
 | 
			
		||||
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
 | 
			
		||||
If you decide to go 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.
 | 
			
		||||
 
 | 
			
		||||
@@ -283,6 +283,7 @@ Consumption templates can assign:
 | 
			
		||||
- Tags, correspondent, document types
 | 
			
		||||
- Document owner
 | 
			
		||||
- View and / or edit permissions to users or groups
 | 
			
		||||
- Custom fields. Note that no value for the field will be set
 | 
			
		||||
 | 
			
		||||
### Consumption template permissions
 | 
			
		||||
 | 
			
		||||
@@ -342,6 +343,7 @@ The following custom field types are supported:
 | 
			
		||||
- `Integer`: integer number e.g. 12
 | 
			
		||||
- `Number`: float number e.g. 12.3456
 | 
			
		||||
- `Monetary`: float number with exactly two decimals, e.g. 12.30
 | 
			
		||||
- `Document Link`: reference(s) to other document(s), displayed as links
 | 
			
		||||
 | 
			
		||||
## Share Links
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user