paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

documentation and changelog

Browse Source
This commit is contained in:
jonaswinkler 2021-02-12 16:54:00 +01:00
parent d6c3471909
commit 6ac90181cb
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/administration.rst
View File

@ -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. Some migrations cannot be undone. The command will issue errors if that happens.
.. _utilities-management-commands:
Management utilities Management utilities
#################### ####################
Paperless comes with some management commands that perform various maintenance 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 .. code:: shell-session
$ cd /path/to/paperless $ cd /path/to/paperless
$ docker-compose exec -u paperless webserver python3 manage.py <command> <arguments> $ docker-compose exec webserver <command> <arguments>
or With docker, while paperless is running:
.. code:: shell-session
$ docker exec -it <container-name> <command> <arguments>
Bare metal:
.. code:: shell-session .. code:: shell-session
$ cd /path/to/paperless/src $ cd /path/to/paperless/src
$ python3 manage.py <command> <arguments> $ python3 manage.py <command> <arguments>
depending on whether you use docker or not.
All commands have built-in help, which can be accessed by executing them with All commands have built-in help, which can be accessed by executing them with
the argument ``--help``. the argument ``--help``.

3
docs/changelog.rst
View File

@ -23,6 +23,9 @@ This release contains new database migrations.
* Added ASN as a placeholder field to the filename format. * 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 paperless-ng 1.1.0
################## ##################