mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
Docs: Fix leftover issues from conversion (#2172)
This commit is contained in:
parent
8b36c9ad64
commit
0472dfe25a
@ -302,7 +302,7 @@ value.
|
|||||||
!!! tip
|
!!! tip
|
||||||
|
|
||||||
You can affect how empty placeholders are treated by changing the
|
You can affect how empty placeholders are treated by changing the
|
||||||
following setting to [true]{.title-ref}.
|
following setting to `true`.
|
||||||
|
|
||||||
```
|
```
|
||||||
PAPERLESS_FILENAME_FORMAT_REMOVE_NONE=True
|
PAPERLESS_FILENAME_FORMAT_REMOVE_NONE=True
|
||||||
@ -364,7 +364,7 @@ Insurances = Insurances/{correspondent}/{created_year}-{created_month}-{created_
|
|||||||
```
|
```
|
||||||
|
|
||||||
If you then map these storage paths to the documents, you might get the
|
If you then map these storage paths to the documents, you might get the
|
||||||
following result. For simplicity, [By Year]{.title-ref} defines the same
|
following result. For simplicity, `By Year` defines the same
|
||||||
structure as in the previous example above.
|
structure as in the previous example above.
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@ -435,7 +435,7 @@ by `root` and should have permissions of `a=rx`. Additionally, scripts
|
|||||||
must only be writable by `root`.
|
must only be writable by `root`.
|
||||||
|
|
||||||
Your scripts will be run directly before the webserver completes
|
Your scripts will be run directly before the webserver completes
|
||||||
startup. Scripts will be run by the [root]{.title-ref} user.
|
startup. Scripts will be run by the `root` user.
|
||||||
If you would like to switch users, the utility `gosu` is available and
|
If you would like to switch users, the utility `gosu` is available and
|
||||||
preferred over `sudo`.
|
preferred over `sudo`.
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Take ownership of k8s-at-home Helm chart, [@alexander-bauer](https://github.com/alexander-bauer) ([#1947](https://github.com/paperless-ngx/paperless-ngx/pull/1947))
|
- Take ownership of k8s-at-home Helm chart [@alexander-bauer](https://github.com/alexander-bauer) ([#1947](https://github.com/paperless-ngx/paperless-ngx/pull/1947))
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
@ -22,7 +22,7 @@
|
|||||||
|
|
||||||
### Maintenance
|
### Maintenance
|
||||||
|
|
||||||
- Take ownership of k8s-at-home Helm chart, [@alexander-bauer](https://github.com/alexander-bauer) ([#1947](https://github.com/paperless-ngx/paperless-ngx/pull/1947))
|
- Take ownership of k8s-at-home Helm chart [@alexander-bauer](https://github.com/alexander-bauer) ([#1947](https://github.com/paperless-ngx/paperless-ngx/pull/1947))
|
||||||
|
|
||||||
### All App Changes
|
### All App Changes
|
||||||
|
|
||||||
@ -991,11 +991,10 @@ This is a maintenance release.
|
|||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
|
|
||||||
The changed to the full text searching require you to reindex your
|
The changed to the full text searching require you to reindex your
|
||||||
documents. _The docker image does this automatically, you don't need to
|
documents. _The docker image does this automatically, you don't need to
|
||||||
do anything._ To do this, execute the `document_index reindex`
|
do anything._ To do this, execute the `document_index reindex`
|
||||||
management command (see `administration-index`{.interpreted-text
|
management command (see [Managing the document search index](/administration#index)).
|
||||||
role="ref"}).
|
|
||||||
|
|
||||||
### paperless-ng 1.3.2
|
### paperless-ng 1.3.2
|
||||||
|
|
||||||
@ -1034,8 +1033,7 @@ This release contains new database migrations.
|
|||||||
- Changes
|
- Changes
|
||||||
- The REST API is versioned from this point onwards. This will
|
- The REST API is versioned from this point onwards. This will
|
||||||
allow me to make changes without breaking existing clients. See
|
allow me to make changes without breaking existing clients. See
|
||||||
the documentation about `api-versioning`{.interpreted-text
|
the documentation about [API versioning](/api#api-versioning) for details.
|
||||||
role="ref"} for details.
|
|
||||||
- Added a color picker for tag colors.
|
- Added a color picker for tag colors.
|
||||||
- Added the ability to use the filter for searching the document
|
- Added the ability to use the filter for searching the document
|
||||||
content as well.
|
content as well.
|
||||||
@ -1069,7 +1067,7 @@ This release contains new database migrations.
|
|||||||
- Changes to the OCRmyPDF integration
|
- Changes to the OCRmyPDF integration
|
||||||
- Added support for deskewing and automatic rotation of
|
- Added support for deskewing and automatic rotation of
|
||||||
incorrectly rotated pages. This is enabled by default, see
|
incorrectly rotated pages. This is enabled by default, see
|
||||||
`configuration-ocr`{.interpreted-text role="ref"}.
|
[OCR settings](/configuration#ocr).
|
||||||
- Better support for encrypted files.
|
- Better support for encrypted files.
|
||||||
- Better support for various other PDF files: Paperless will now
|
- Better support for various other PDF files: Paperless will now
|
||||||
attempt to force OCR with safe options when OCR fails with the
|
attempt to force OCR with safe options when OCR fails with the
|
||||||
@ -1096,7 +1094,7 @@ This release contains new database migrations.
|
|||||||
|
|
||||||
- Added a docker-specific configuration option to adjust the number of
|
- Added a docker-specific configuration option to adjust the number of
|
||||||
worker processes of the web server. See
|
worker processes of the web server. See
|
||||||
`configuration-docker`{.interpreted-text role="ref"}.
|
[Docker options](/configuration#docker).
|
||||||
- Some more memory usage optimizations.
|
- Some more memory usage optimizations.
|
||||||
- Don't show inbox statistics if no inbox tag is defined.
|
- Don't show inbox statistics if no inbox tag is defined.
|
||||||
|
|
||||||
@ -1105,8 +1103,7 @@ This release contains new database migrations.
|
|||||||
- Always show top left corner of thumbnails, even for extra wide
|
- Always show top left corner of thumbnails, even for extra wide
|
||||||
documents.
|
documents.
|
||||||
- Added a management command for executing the sanity checker
|
- Added a management command for executing the sanity checker
|
||||||
directly. See `utilities-sanity-checker`{.interpreted-text
|
directly. See [management utilities](/administration#sanity-checker).
|
||||||
role="ref"}.
|
|
||||||
- The weekly sanity check now reports messages in the log files.
|
- The weekly sanity check now reports messages in the log files.
|
||||||
- Fixed an issue with the metadata tab not reporting anything in case
|
- Fixed an issue with the metadata tab not reporting anything in case
|
||||||
of missing files.
|
of missing files.
|
||||||
@ -1140,7 +1137,7 @@ This release contains new database migrations.
|
|||||||
management commands, since these also ensure that they're always
|
management commands, since these also ensure that they're always
|
||||||
executed as the paperless user and you're less likely to run into
|
executed as the paperless user and you're less likely to run into
|
||||||
permission issues. See
|
permission issues. See
|
||||||
`utilities-management-commands`{.interpreted-text role="ref"}.
|
[management commands](/administration#management-commands).
|
||||||
|
|
||||||
### paperless-ng 1.1.0
|
### paperless-ng 1.1.0
|
||||||
|
|
||||||
@ -1182,7 +1179,7 @@ This release contains new database migrations.
|
|||||||
status notifications.
|
status notifications.
|
||||||
|
|
||||||
Apache `mod_wsgi` users, see
|
Apache `mod_wsgi` users, see
|
||||||
`this note <faq-mod_wsgi>`{.interpreted-text role="ref"}.
|
[this note](/faq#how-do-i-get-websocket-support-with-apache-mod_wsgi).
|
||||||
|
|
||||||
- Paperless now offers suggestions for tags, correspondents and types
|
- Paperless now offers suggestions for tags, correspondents and types
|
||||||
on the document detail page.
|
on the document detail page.
|
||||||
@ -1227,9 +1224,7 @@ bug reports coming in, I think that this is reasonably stable.
|
|||||||
- The document exporter locks the media directory and the database
|
- The document exporter locks the media directory and the database
|
||||||
during execution to ensure that the resulting export is
|
during execution to ensure that the resulting export is
|
||||||
consistent.
|
consistent.
|
||||||
- See the
|
- See the [updated documentation](/administration#exporter) for more details.
|
||||||
`updated documentation <utilities-exporter>`{.interpreted-text
|
|
||||||
role="ref"} for more details.
|
|
||||||
- Other changes and additions
|
- Other changes and additions
|
||||||
- Added a language selector to the settings.
|
- Added a language selector to the settings.
|
||||||
- Added date format options to the settings.
|
- Added date format options to the settings.
|
||||||
@ -1318,11 +1313,11 @@ paperless.
|
|||||||
- Thanks to [Jo Vandeginste](https://github.com/jovandeginste),
|
- Thanks to [Jo Vandeginste](https://github.com/jovandeginste),
|
||||||
Paperless has optional support for Office documents such as .docx,
|
Paperless has optional support for Office documents such as .docx,
|
||||||
.doc, .odt and more.
|
.doc, .odt and more.
|
||||||
- See the `configuration<configuration-tika>`{.interpreted-text
|
- See the [Tika settings](/configuration#tika) on how to enable this
|
||||||
role="ref"} on how to enable this feature. This feature requires
|
feature. This feature requires two additional services (one for
|
||||||
two additional services (one for parsing Office documents and
|
parsing Office documents and metadata extraction and another for
|
||||||
metadata extraction and another for converting Office documents
|
converting Office documents to PDF), and is therefore not enabled
|
||||||
to PDF), and is therefore not enabled on default installations.
|
on default installations.
|
||||||
- As with all other documents, paperless converts Office documents
|
- As with all other documents, paperless converts Office documents
|
||||||
to PDF and stores both the original as well as the archived PDF.
|
to PDF and stores both the original as well as the archived PDF.
|
||||||
- Dark mode
|
- Dark mode
|
||||||
@ -1398,15 +1393,14 @@ paperless.
|
|||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
|
|
||||||
The bulk delete operations did not update the search index. Therefore,
|
The bulk delete operations did not update the search index. Therefore,
|
||||||
documents that you deleted remained in the index and caused the search
|
documents that you deleted remained in the index and caused the search
|
||||||
to return messages about missing documents when searching. Further bulk
|
to return messages about missing documents when searching. Further bulk
|
||||||
operations will properly update the index.
|
operations will properly update the index.
|
||||||
|
|
||||||
However, this change is not retroactive: If you used the delete method
|
However, this change is not retroactive: If you used the delete method
|
||||||
of the bulk editor, you need to reindex your search index by
|
of the bulk editor, you need to reindex your search index by
|
||||||
`running the management command document_index with the argument reindex <administration-index>`{.interpreted-text
|
[running the management command `document_index` with the argument `reindex`](/administration#index).
|
||||||
role="ref"}.
|
|
||||||
|
|
||||||
### paperless-ng 0.9.9
|
### paperless-ng 0.9.9
|
||||||
|
|
||||||
@ -1563,17 +1557,14 @@ primarily.
|
|||||||
edit page. If available, a dropdown menu will appear next to the
|
edit page. If available, a dropdown menu will appear next to the
|
||||||
download button.
|
download button.
|
||||||
- Many of the configuration options regarding OCR have changed.
|
- Many of the configuration options regarding OCR have changed.
|
||||||
See `configuration-ocr`{.interpreted-text role="ref"} for
|
See [OCR settings](/configuration#ocr) for details.
|
||||||
details.
|
|
||||||
- Paperless no longer guesses the language of your documents. It
|
- Paperless no longer guesses the language of your documents. It
|
||||||
always uses the language that you specified with
|
always uses the language that you specified with
|
||||||
`PAPERLESS_OCR_LANGUAGE`. Be sure to set this to the language
|
`PAPERLESS_OCR_LANGUAGE`. Be sure to set this to the language
|
||||||
the majority of your documents are in. Multiple languages can be
|
the majority of your documents are in. Multiple languages can be
|
||||||
specified, but that requires more CPU time.
|
specified, but that requires more CPU time.
|
||||||
- The management command
|
- The management command [`document_archiver`](/administration#archiver)
|
||||||
`document_archiver <utilities-archiver>`{.interpreted-text
|
can be used to create archived versions for already existing documents.
|
||||||
role="ref"} can be used to create archived versions for already
|
|
||||||
existing documents.
|
|
||||||
- Tags from consumption folder.
|
- Tags from consumption folder.
|
||||||
- Thanks to [jayme-github](https://github.com/jayme-github),
|
- Thanks to [jayme-github](https://github.com/jayme-github),
|
||||||
paperless now consumes files from sub folders in the consumption
|
paperless now consumes files from sub folders in the consumption
|
||||||
@ -1586,7 +1577,7 @@ primarily.
|
|||||||
- The endpoint for uploading documents now supports specifying
|
- The endpoint for uploading documents now supports specifying
|
||||||
custom titles, correspondents, tags and types. This can be used
|
custom titles, correspondents, tags and types. This can be used
|
||||||
by clients to override the default behavior of paperless. See
|
by clients to override the default behavior of paperless. See
|
||||||
`api-file_uploads`{.interpreted-text role="ref"}.
|
[POSTing documents](/api#file-uploads).
|
||||||
- The document endpoint of API now serves documents in this form:
|
- The document endpoint of API now serves documents in this form:
|
||||||
- correspondents, document types and tags are referenced by
|
- correspondents, document types and tags are referenced by
|
||||||
their ID in the fields `correspondent`, `document_type` and
|
their ID in the fields `correspondent`, `document_type` and
|
||||||
@ -1620,16 +1611,14 @@ primarily.
|
|||||||
- Paperless now supports searching by tags, types and dates and
|
- Paperless now supports searching by tags, types and dates and
|
||||||
correspondents. In order to have this applied to your existing
|
correspondents. In order to have this applied to your existing
|
||||||
documents, you need to perform a `document_index reindex`
|
documents, you need to perform a `document_index reindex`
|
||||||
management command (see `administration-index`{.interpreted-text
|
management command (see [document search index](/administration#index))
|
||||||
role="ref"}) that adds the data to the search index. You only
|
that adds the data to the search index. You only need to do this
|
||||||
need to do this once, since the schema of the search index
|
once, since the schema of the search index changed. Paperless
|
||||||
changed. Paperless keeps the index updated after that whenever
|
keeps the index updated after that whenever something changes.
|
||||||
something changes.
|
|
||||||
- Paperless now has spelling corrections ("Did you mean") for
|
- Paperless now has spelling corrections ("Did you mean") for
|
||||||
miss-typed queries.
|
miss-typed queries.
|
||||||
- The documentation contains
|
- The documentation contains
|
||||||
`information about the query syntax <basic-searching>`{.interpreted-text
|
[information about the query syntax](/usage#basic-usage_searching).
|
||||||
role="ref"}.
|
|
||||||
- Front end:
|
- Front end:
|
||||||
- Clickable tags, correspondents and types allow quick filtering
|
- Clickable tags, correspondents and types allow quick filtering
|
||||||
for related documents.
|
for related documents.
|
||||||
@ -1748,7 +1737,7 @@ primarily.
|
|||||||
uses PostgreSQL instead of SQLite. Username, database and
|
uses PostgreSQL instead of SQLite. Username, database and
|
||||||
password all default to `paperless` if not specified.
|
password all default to `paperless` if not specified.
|
||||||
- **Modified \[breaking\]:** document_retagger management command
|
- **Modified \[breaking\]:** document_retagger management command
|
||||||
rework. See `utilities-retagger`{.interpreted-text role="ref"} for
|
rework. See [Document retagger](/administration#retagger) for
|
||||||
details. Replaces `document_correspondents` management command.
|
details. Replaces `document_correspondents` management command.
|
||||||
- **Removed \[breaking\]:** Reminders.
|
- **Removed \[breaking\]:** Reminders.
|
||||||
- **Removed:** All customizations made to the django admin pages.
|
- **Removed:** All customizations made to the django admin pages.
|
||||||
|
@ -328,8 +328,8 @@ supported.
|
|||||||
|
|
||||||
- `PAPERLESS_REDIS` should point to your redis server, such as
|
- `PAPERLESS_REDIS` should point to your redis server, such as
|
||||||
<redis://localhost:6379>.
|
<redis://localhost:6379>.
|
||||||
- `PAPERLESS_DBENGINE` optional, and should be one of [postgres,
|
- `PAPERLESS_DBENGINE` optional, and should be one of `postgres`,
|
||||||
mariadb, or sqlite]{.title-ref}
|
`mariadb`, or `sqlite`
|
||||||
- `PAPERLESS_DBHOST` should be the hostname on which your
|
- `PAPERLESS_DBHOST` should be the hostname on which your
|
||||||
PostgreSQL server is running. Do not configure this to use
|
PostgreSQL server is running. Do not configure this to use
|
||||||
SQLite instead. Also configure port, database name, user and
|
SQLite instead. Also configure port, database name, user and
|
||||||
|
@ -222,7 +222,7 @@ This might have multiple reasons.
|
|||||||
SENDFILE=0
|
SENDFILE=0
|
||||||
```
|
```
|
||||||
|
|
||||||
to your [docker-compose.env]{.title-ref} file.
|
to your `docker-compose.env` file.
|
||||||
|
|
||||||
## Error while reading metadata
|
## Error while reading metadata
|
||||||
|
|
||||||
@ -326,9 +326,9 @@ unlock. This may have minor performance implications.
|
|||||||
## gunicorn fails to start with "is not a valid port number"
|
## gunicorn fails to start with "is not a valid port number"
|
||||||
|
|
||||||
You are likely running using Kubernetes, which automatically creates an
|
You are likely running using Kubernetes, which automatically creates an
|
||||||
environment variable named [\${serviceName}\_PORT]{.title-ref}. This is
|
environment variable named `${serviceName}_PORT`. This is
|
||||||
the same environment variable which is used by Paperless to optionally
|
the same environment variable which is used by Paperless to optionally
|
||||||
change the port gunicorn listens on.
|
change the port gunicorn listens on.
|
||||||
|
|
||||||
To fix this, set [PAPERLESS_PORT]{.title-ref} again to your desired
|
To fix this, set `PAPERLESS_PORT` again to your desired port, or the
|
||||||
port, or the default of 8000.
|
default of 8000.
|
||||||
|
@ -195,7 +195,7 @@ configured on the 'Scheduled tasks' page in the admin.
|
|||||||
|
|
||||||
### REST API
|
### REST API
|
||||||
|
|
||||||
You can also submit a document using the REST API, see [docs][api#file-uploads]
|
You can also submit a document using the REST API, see [POSTing documents][/api#file-uploads]
|
||||||
for details.
|
for details.
|
||||||
|
|
||||||
## Best practices {#basic-searching}
|
## Best practices {#basic-searching}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user