obsidian-plugin/talal-a_obsidian-paperless
1
0
Fork 0
mirror of https://github.com/talal-a/obsidian-paperless.git synced 2026-07-22 11:40:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
30 commits 1 branch 19 tags 182 KiB
TypeScript 83.9%
CSS 9.8%
JavaScript 6.3%
Find a file
Talal Abou Haiba 01ca0d259c Fix #7 - increased page size to ensure scroll bar appears in modal
2025-01-04 13:20:26 -08:00
.github/workflows Adding release.yml 2024-09-04 21:37:14 -07:00
.editorconfig Initial commit 2024-09-04 21:22:31 -07:00
.eslintignore Initial commit 2024-09-04 21:22:31 -07:00
.eslintrc Initial commit 2024-09-04 21:22:31 -07:00
.gitignore Initial commit 2024-09-04 21:22:31 -07:00
.hotreload Enable .hotreload 2024-09-04 21:31:37 -07:00
.npmrc Initial commit 2024-09-04 21:22:31 -07:00
esbuild.config.mjs Initial commit 2024-09-04 21:22:31 -07:00
LICENSE Adding license 2024-09-04 21:32:34 -07:00
main.ts Fix #7 - increased page size to ensure scroll bar appears in modal 2025-01-04 13:20:26 -08:00
manifest.json Fix #7 - increased page size to ensure scroll bar appears in modal 2025-01-04 13:20:26 -08:00
package-lock.json Minor - remove placeholder comment 2024-09-04 22:02:40 -07:00
package.json Initial commit 2024-09-04 21:22:31 -07:00
README.md #5 - basic README 2024-12-30 18:41:12 -08:00
styles.css Version bump 2024-12-28 16:18:00 -08:00
tsconfig.json Initial commit 2024-09-04 21:22:31 -07:00
version-bump.mjs Initial commit 2024-09-04 21:22:31 -07:00
versions.json Initial commit 2024-09-04 21:22:31 -07:00

README.md

Obsidian ❤️ Paperless-ngx

⚠️ Under construction - this plugin is not ready for any public consumption ⚠️

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 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++ 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. 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

  1. Install the plugin.
  2. Install PDF++.
  3. 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.