paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-10-30 03:56:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: copy-edits (#10417)

Browse Source
This commit is contained in:
Katrin Leinweber
2025-07-20 19:27:04 +02:00
committed by GitHub
parent 4b8f6ed643
commit 5410074062
11 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -141,7 +141,7 @@ The admins occasionally invite contributors directly if we believe having them o
# Automatic Repository Maintenance # Automatic Repository Maintenance
The Paperless-ngx team appreciates all effort and interest from the community in filing bug reports, creating feature requests, sharing ideas and helping other The Paperless-ngx team appreciates all effort and interest from the community in filing bug reports, creating feature requests, sharing ideas and helping other
community members. That said, in an effort to keep the repository organized and managebale the project uses automatic handling of certain areas: community members. That said, in an effort to keep the repository organized and manageable the project uses automatic handling of certain areas:
- Issues that cannot be reproduced will be marked 'stale' after 7 days of inactivity and closed after 14 further days of inactivity. - Issues that cannot be reproduced will be marked 'stale' after 7 days of inactivity and closed after 14 further days of inactivity.
- Issues, pull requests and discussions that are closed will be locked after 30 days of inactivity. - Issues, pull requests and discussions that are closed will be locked after 30 days of inactivity.

2
docker/compose/docker-compose.ci-test.yml
View File

@@ -1,4 +1,4 @@
# Docker Compose file for running paperless testing with actual gotenberg # Docker Compose file for running paperless testing with actual Gotenberg
# and Tika containers for a more end to end test of the Tika related functionality # and Tika containers for a more end to end test of the Tika related functionality
# Can be used locally or by the CI to start the necessary containers with the # Can be used locally or by the CI to start the necessary containers with the
# correct networking for the tests # correct networking for the tests

4
docker/compose/docker-compose.mariadb-tika.yml
View File

@@ -16,8 +16,8 @@
# - Instead of SQLite (default), MariaDB is used as the database server. # - Instead of SQLite (default), MariaDB is used as the database server.
# - Apache Tika and Gotenberg servers are started with paperless and paperless # - Apache Tika and Gotenberg servers are started with paperless and paperless
# is configured to use these services. These provide support for consuming # is configured to use these services. These provide support for consuming
# Office documents (Word, Excel, Power Point and their LibreOffice counter- # Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
# parts. # parts).
# #
# To install and update paperless with this file, do the following: # To install and update paperless with this file, do the following:
# #

4
docker/compose/docker-compose.postgres-tika.yml
View File

@@ -16,8 +16,8 @@
# - Instead of SQLite (default), PostgreSQL is used as the database server. # - Instead of SQLite (default), PostgreSQL is used as the database server.
# - Apache Tika and Gotenberg servers are started with paperless and paperless # - Apache Tika and Gotenberg servers are started with paperless and paperless
# is configured to use these services. These provide support for consuming # is configured to use these services. These provide support for consuming
# Office documents (Word, Excel, Power Point and their LibreOffice counter- # Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
# parts. # parts).
# #
# To install and update paperless with this file, do the following: # To install and update paperless with this file, do the following:
# #

4
docker/compose/docker-compose.sqlite-tika.yml
View File

@@ -16,8 +16,8 @@
# #
# - Apache Tika and Gotenberg servers are started with paperless and paperless # - Apache Tika and Gotenberg servers are started with paperless and paperless
# is configured to use these services. These provide support for consuming # is configured to use these services. These provide support for consuming
# Office documents (Word, Excel, Power Point and their LibreOffice counter- # Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
# parts. # parts).
# #
# To install and update paperless with this file, do the following: # To install and update paperless with this file, do the following:
# #

2
docs/administration.md
View File

@@ -306,7 +306,7 @@ in dedicated folders according to their nature: `archive`, `originals`,
If `-sm` or `--split-manifest` is provided, information about document 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 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, 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 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 in the target directory, named according to the current local date or the

12
docs/development.md
View File

@@ -95,13 +95,13 @@ first-time setup.
7. You can now either ... 7. You can now either ...
- install redis or - install Redis or
- use the included `scripts/start_services.sh` to use docker to fire - use the included `scripts/start_services.sh` to use Docker to fire
up a redis instance (and some other services such as tika, up a Redis instance (and some other services such as Tika,
gotenberg and a database server) or 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 docker run -d -p 6379:6379 --restart unless-stopped redis:latest
@@ -147,7 +147,7 @@ $ ng build --configuration production
### Testing ### Testing
- Run `pytest` in the `src/` directory to execute all tests. This also - 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 is loaded as well. However, the tests rely on the default
configuration. This is not ideal. But for now, make sure no settings configuration. This is not ideal. But for now, make sure no settings
except for DEBUG are overridden when testing. except for DEBUG are overridden when testing.

2
docs/index.md
View File

@@ -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. - 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. - 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. - 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. - 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: - **Beautiful, modern web application** that features:
- Customizable dashboard with statistics. - Customizable dashboard with statistics.

2
docs/setup.md
View File

@@ -445,7 +445,7 @@ are released, dependency support is confirmed, etc.
13. Configure ImageMagick to allow processing of PDF documents. Most 13. Configure ImageMagick to allow processing of PDF documents. Most
distributions have this disabled by default, since PDF documents can distributions have this disabled by default, since PDF documents can
contain malware. If you don't do this, paperless will fall back to 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 Edit `/etc/ImageMagick-6/policy.xml` and adjust

2
docs/troubleshooting.md
View File

@@ -335,7 +335,7 @@ You may see errors when deleting documents like:
Data too long for column 'transaction_id' at row 1 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 ```shell-session
$ python3 manage.py convert_mariadb_uuid $ python3 manage.py convert_mariadb_uuid

20
install-paperless-ngx.sh
View File

@@ -52,12 +52,12 @@ if ! command -v wget &> /dev/null ; then
fi fi
if ! command -v docker &> /dev/null ; then if ! command -v docker &> /dev/null ; then
echo "docker executable not found. Is docker installed?" echo "docker executable not found. Is Docker installed?"
exit 1 exit 1
fi fi
if ! docker compose &> /dev/null ; then if ! docker compose &> /dev/null ; then
echo "docker compose plugin not found. Is docker compose installed?" echo "docker compose plugin not found. Is Docker Compose installed?"
exit 1 exit 1
fi fi
@@ -66,7 +66,7 @@ fi
if ! docker stats --no-stream &> /dev/null ; then if ! docker stats --no-stream &> /dev/null ; then
echo "" echo ""
echo "WARN: It look like the current user does not have Docker permissions." echo "WARN: It look like the current user does not have Docker permissions."
echo "WARN: Use 'sudo usermod -aG docker $USER' to assign Docker permissions to the user (may require restarting shell)." echo "WARN: Use 'sudo usermod -aG docker $USER' to assign Docker permissions to the user (may require restarting the shell)."
echo "" echo ""
sleep 3 sleep 3
fi fi
@@ -135,7 +135,7 @@ DATABASE_BACKEND=$ask_result
echo "" echo ""
echo "Paperless is able to use Apache Tika to support Office documents such as" echo "Paperless is able to use Apache Tika to support Office documents such as"
echo "Word, Excel, Powerpoint, and Libreoffice equivalents. This feature" echo "Word, Excel, PowerPoint, and LibreOffice equivalents. This feature"
echo "requires more resources due to the required services." echo "requires more resources due to the required services."
echo "" echo ""
@@ -157,7 +157,7 @@ echo ""
echo "Specify the user id and group id you wish to run paperless as." echo "Specify the user id and group id you wish to run paperless as."
echo "Paperless will also change ownership on the data, media and consume" echo "Paperless will also change ownership on the data, media and consume"
echo "folder to the specified values, so it's a good idea to supply the user id" echo "folder to the specified values, so it's a good idea to supply the user id"
echo "and group id of your unix user account." echo "and group id of your Unix user account."
echo "If unsure, leave default." echo "If unsure, leave default."
echo "" echo ""
@@ -212,7 +212,7 @@ if [[ "$DATABASE_BACKEND" == "sqlite" ]] ; then
echo -n "SQLite database, the " echo -n "SQLite database, the "
fi fi
echo "search index and other data." echo "search index and other data."
echo "As with the media folder, leave empty to have this managed by docker." echo "As with the media folder, leave empty to have this managed by Docker."
echo "" echo ""
echo "CAUTION: If specified, you must specify an absolute path starting with /" echo "CAUTION: If specified, you must specify an absolute path starting with /"
echo "or a relative path starting with ./ here." echo "or a relative path starting with ./ here."
@@ -224,7 +224,7 @@ DATA_FOLDER=$ask_result
if [[ "$DATABASE_BACKEND" == "postgres" || "$DATABASE_BACKEND" == "mariadb" ]] ; then if [[ "$DATABASE_BACKEND" == "postgres" || "$DATABASE_BACKEND" == "mariadb" ]] ; then
echo "" echo ""
echo "The database folder, where your database stores its data." echo "The database folder, where your database stores its data."
echo "Leave empty to have this managed by docker." echo "Leave empty to have this managed by Docker."
echo "" echo ""
echo "CAUTION: If specified, you must specify an absolute path starting with /" echo "CAUTION: If specified, you must specify an absolute path starting with /"
echo "or a relative path starting with ./ here." echo "or a relative path starting with ./ here."
@@ -276,18 +276,18 @@ echo ""
echo "Target folder: $TARGET_FOLDER" echo "Target folder: $TARGET_FOLDER"
echo "Consume folder: $CONSUME_FOLDER" echo "Consume folder: $CONSUME_FOLDER"
if [[ -z $MEDIA_FOLDER ]] ; then if [[ -z $MEDIA_FOLDER ]] ; then
echo "Media folder: Managed by docker" echo "Media folder: Managed by Docker"
else else
echo "Media folder: $MEDIA_FOLDER" echo "Media folder: $MEDIA_FOLDER"
fi fi
if [[ -z $DATA_FOLDER ]] ; then if [[ -z $DATA_FOLDER ]] ; then
echo "Data folder: Managed by docker" echo "Data folder: Managed by Docker"
else else
echo "Data folder: $DATA_FOLDER" echo "Data folder: $DATA_FOLDER"
fi fi
if [[ "$DATABASE_BACKEND" == "postgres" || "$DATABASE_BACKEND" == "mariadb" ]] ; then if [[ "$DATABASE_BACKEND" == "postgres" || "$DATABASE_BACKEND" == "mariadb" ]] ; then
if [[ -z $DATABASE_FOLDER ]] ; then if [[ -z $DATABASE_FOLDER ]] ; then
echo "Database folder: Managed by docker" echo "Database folder: Managed by Docker"
else else
echo "Database folder: $DATABASE_FOLDER" echo "Database folder: $DATABASE_FOLDER"
fi fi