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

Update administration docs with ansible update

Browse Source
This commit is contained in:
Fabian Koller
2021-01-18 22:48:06 +01:00
parent 8884a4dfdf
commit 74a1b36005
1 changed files with 46 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/administration.rst
View File

@@ -53,6 +53,9 @@ Restoring
Updating Paperless Updating Paperless
################## ##################
Docker Route
============
If a new release of paperless-ng is available, upgrading depends on how you If a new release of paperless-ng is available, upgrading depends on how you
installed paperless-ng in the first place. The releases are available at the installed paperless-ng in the first place. The releases are available at the
`release page <https://github.com/jonaswinkler/paperless-ng/releases>`_. `release page <https://github.com/jonaswinkler/paperless-ng/releases>`_.
@@ -89,8 +92,8 @@ Running `docker-compose up` will also apply any new database migrations.
If you see everything working, press CTRL+C once to gracefully stop paperless. If you see everything working, press CTRL+C once to gracefully stop paperless.
Then you can start paperless-ng with ``-d`` to have it run in the background. Then you can start paperless-ng with ``-d`` to have it run in the background.
Updating paperless without docker Bare Metal Route
================================= ================
After grabbing the new release and unpacking the contents, do the following: After grabbing the new release and unpacking the contents, do the following:
@@ -123,6 +126,38 @@ After grabbing the new release and unpacking the contents, do the following:
This might not actually do anything. Not every new paperless version comes with new This might not actually do anything. Not every new paperless version comes with new
database migrations. database migrations.
Ansible Route
=============
Most of the update process is automated when using the ansible role.
1. Backup your defined role variables file outside the paperless source-tree:
.. code:: shell-session
$ cp ansible/vars.yml ~/vars.yml.old
2. Pull the release tag you want to update to:
.. code:: shell-session
$ git fetch --all
$ git checkout ng-0.9.14
3. Update the role variable definitions ``ansible/vars.yml`` (where appropriate).
4. Run the ansible playbook you created created during :ref:`installation <setup-ansible>` again:
.. note::
When ansible detects that an update run is in progress, it backs up the entire ``paperlessng_directory`` to ``paperlessng_directory-TIMESTAMP``.
Updates can be rolled back by simply moving the timestamped folder back to the original location.
If the update succeeds and you want to continue using the new release, please don't forget to delete the backup folder.
.. code:: shell-session
$ ansible-playbook playbook.yml
Management utilities Management utilities
#################### ####################