From 6ac90181cbc8bf56ac9c9060117c750399a1fda9 Mon Sep 17 00:00:00 2001 From: jonaswinkler Date: Fri, 12 Feb 2021 16:54:00 +0100 Subject: [PATCH] documentation and changelog --- docs/administration.rst | 18 +++++++++++++----- docs/changelog.rst | 3 +++ 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/administration.rst b/docs/administration.rst index 21b6ebcea..5773a80cc 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -206,26 +206,34 @@ Execute the following management command to migrate your database: Some migrations cannot be undone. The command will issue errors if that happens. +.. _utilities-management-commands: + Management utilities #################### Paperless comes with some management commands that perform various maintenance -tasks on your paperless instance. You can invoke these commands either by +tasks on your paperless instance. You can invoke these commands in the following way: + +With docker-compose, while paperless is running: .. code:: shell-session $ cd /path/to/paperless - $ docker-compose exec -u paperless webserver python3 manage.py + $ docker-compose exec webserver -or +With docker, while paperless is running: + +.. code:: shell-session + + $ docker exec -it + +Bare metal: .. code:: shell-session $ cd /path/to/paperless/src $ python3 manage.py -depending on whether you use docker or not. - All commands have built-in help, which can be accessed by executing them with the argument ``--help``. diff --git a/docs/changelog.rst b/docs/changelog.rst index a0ca5e5c9..bf07a3c6a 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -23,6 +23,9 @@ This release contains new database migrations. * Added ASN as a placeholder field to the filename format. +* The docker image now comes with built-in shortcuts for most management commands. These are now the recommended way to execute management commands, since these + also ensure that they're always executed as the paperless user and you're less likely to run into permission issues. See :ref:`utilities-management-commands`. + paperless-ng 1.1.0 ##################