Skip to content

Commit

Permalink
#5 - basic README
Browse files Browse the repository at this point in the history
  • Loading branch information
Talal-A committed Dec 31, 2024
1 parent 3d7214e commit 9aeaa67
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,21 @@ This assumes you have a working version of [paperless-ngx](https://github.com/pa

You must also have the ✨amazing✨ [PDF++](https://github.com/RyotaUshio/obsidian-pdf-plus) plugin installed!

## How it works
This plugin interacts with your paperless instance to enable seamless viewing of your documents within Obsidian. When you click on a document to import it will generate a share link from paperless and embed it into a *external PDF file*. Read more [here](https://ryotaushio.github.io/obsidian-pdf-plus/external-pdf-files.html). You can now view that document as though it was natively loaded in your vault, without needing to worry about local or remote storage limits.

## Setup

**Paperless-ngx**

1. ...
1. Obtain an authorization token for your account. Open the "My Profile" link in the user dropdown found in the paperless-ngx web UI. Copy the API Auth Token.


**Obsidian**

1. Install the plugin.
1. Install [PDF++](https://github.com/RyotaUshio/obsidian-pdf-plus).
1. Fill in the following settings:
2. Install the plugin.
3. Install [PDF++](https://github.com/RyotaUshio/obsidian-pdf-plus).
4. Fill in the following settings:
- Paperless URL: full url to your paperless-ngx instance. Do not include the trailing `/`.
- Paperless authentication token: TK
- TK
- Paperless authentication token: token you obtained in step 1.
- Document storage path: location you would like to save references to these PDFs.

0 comments on commit 9aeaa67

Please sign in to comment.