mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 03:16:10 -06:00 
			
		
		
		
	Update administration docs with ansible update
This commit is contained in:
		@@ -53,6 +53,9 @@ Restoring
 | 
			
		||||
Updating Paperless
 | 
			
		||||
##################
 | 
			
		||||
 | 
			
		||||
Docker Route
 | 
			
		||||
============
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
`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.
 | 
			
		||||
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:
 | 
			
		||||
 | 
			
		||||
@@ -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
 | 
			
		||||
    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
 | 
			
		||||
####################
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user