Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adding instructions for after upgrading paperless-ngx
  • Loading branch information
jgillula authored Jun 21, 2023
1 parent 2f286a0 commit f905398
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Still in the directory of your Paperless-ngx instance, run the following command
docker-compose exec -u paperless webserver /usr/src/paperless-ngx-postprocessor/setup_venv.sh
```

Note that if you are running paperless-ngx in a Docker container, you will need to redo this step after any time you upgrade.

### 3. Create an auth token
Next we'll need create an authentication token in your Paperless-ngx instance. To do this, go to the 'Add token' page in your paperless-ngx admin console, e.g. [http://localhost:8000/admin/authtoken/tokenproxy/add/](http://localhost:8000/admin/authtoken/tokenproxy/add/). Choose which user you want paperless-ngx-postprocessor to run as, and then click "SAVE".

Expand Down Expand Up @@ -311,6 +313,10 @@ To restore backup to undo changes, do:

If you want to see what the restore will do, you can open up the backup file in a text editor. Inside is just a yaml document with all of the document IDs and what their fields should be restored to.

### Upgrading

If you are running paperless-ngx in a Docker container, you will need to redo [setup step two](#2-run-the-one-time-setup-script-inside-the-paperless-ngx-docker-container) after any time you upgrade paperless-ngx.

## FAQ

### Will this work with paperless or paperless-ng?
Expand Down

0 comments on commit f905398

Please sign in to comment.