# 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
-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, pull requests and discussions that are closed will be locked after 30 days of inactivity.
-# 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
# Can be used locally or by the CI to start the necessary containers with the
# correct networking for the tests
# - Instead of SQLite (default), MariaDB is used as the database server.
# - Apache Tika and Gotenberg servers are started with paperless and paperless
# is configured to use these services. These provide support for consuming
-# Office documents (Word, Excel, Power Point and their LibreOffice counter-
-# parts.
+# Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
+# parts).
#
# To install and update paperless with this file, do the following:
#
# - Instead of SQLite (default), PostgreSQL is used as the database server.
# - Apache Tika and Gotenberg servers are started with paperless and paperless
# is configured to use these services. These provide support for consuming
-# Office documents (Word, Excel, Power Point and their LibreOffice counter-
-# parts.
+# Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
+# parts).
#
# To install and update paperless with this file, do the following:
#
#
# - Apache Tika and Gotenberg servers are started with paperless and paperless
# is configured to use these services. These provide support for consuming
-# Office documents (Word, Excel, Power Point and their LibreOffice counter-
-# parts.
+# Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
+# parts).
#
# To install and update paperless with this file, do the following:
#
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
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
### 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.
- 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.
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
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
fi
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
fi
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
fi
if ! docker stats --no-stream &> /dev/null ; then
echo ""
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 ""
sleep 3
fi
echo ""
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 ""
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 "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 ""
echo -n "SQLite database, the "
fi
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 "CAUTION: If specified, you must specify an absolute path starting with /"
echo "or a relative path starting with ./ here."
if [[ "$DATABASE_BACKEND" == "postgres" || "$DATABASE_BACKEND" == "mariadb" ]] ; then
echo ""
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 "CAUTION: If specified, you must specify an absolute path starting with /"
echo "or a relative path starting with ./ here."
echo "Target folder: $TARGET_FOLDER"
echo "Consume folder: $CONSUME_FOLDER"
if [[ -z $MEDIA_FOLDER ]] ; then
- echo "Media folder: Managed by docker"
+ echo "Media folder: Managed by Docker"
else
echo "Media folder: $MEDIA_FOLDER"
fi
if [[ -z $DATA_FOLDER ]] ; then
- echo "Data folder: Managed by docker"
+ echo "Data folder: Managed by Docker"
else
echo "Data folder: $DATA_FOLDER"
fi
if [[ "$DATABASE_BACKEND" == "postgres" || "$DATABASE_BACKEND" == "mariadb" ]] ; then
if [[ -z $DATABASE_FOLDER ]] ; then
- echo "Database folder: Managed by docker"
+ echo "Database folder: Managed by Docker"
else
echo "Database folder: $DATABASE_FOLDER"
fi
projects / thirdparty / paperless-ngx.git / commitdiff
