https://github.com/talal-a/obsidian-paperless
https://github.com/talal-a/obsidian-paperless
obsidian obsidian-plugin paperless-ngx
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/talal-a/obsidian-paperless
- Owner: Talal-A
- License: mit
- Created: 2024-09-05T04:22:29.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-02T00:32:10.000Z (8 months ago)
- Last Synced: 2025-02-02T01:24:15.713Z (8 months ago)
- Topics: obsidian, obsidian-plugin, paperless-ngx
- Language: TypeScript
- Homepage:
- Size: 67.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Obsidian ❤️ Paperless-ngx
This plugin allows users to easily insert PDFs from their self-hosted paperless-ngx instance into their Obsidian notes.
## Features
- View all documents on your paperless-ngx instance from within the comfort of your Obsidian vault.
- One-click insertion of one or many documents into your vault.
## Prerequisites
This assumes you have a working version of [paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) hosted. It does not necessarily need to be remotely accessible. This decision is left up to the reader.
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. 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**
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: token you obtained in step 1.
- Document storage path: location you would like to save references to these PDFs.