Paperless-ngx Document Links

pending

by Ahn1

Integrates Paperless-ngx with document search and reference cards as links.

Updated 2mo agoApache-2.0Discovered via Obsidian Unofficial Plugins
View on GitHub

Paperless-ngx Linking for Obsidian

An Obsidian plugin that integrates with Paperless-ngx to reference your documents directly from your notes.

Why This Plugin?

There is a existing Paperless plugins for Obsidian that embed documents directly into your vault. This plugin takes a different approach: it only links to your documents without copying them into Obsidian.

Features

  • Search Documents — Search your Paperless-ngx documents directly from Obsidian
  • Filter by Tags & Correspondents — Narrow down results using your existing Paperless metadata
  • Visual Reference Cards — Inserted references render as clickable cards with thumbnail, title, and date
  • Slash Command — Type /paperless to quickly insert a document reference
  • Direct Links — Click a reference card to open the document in your Paperless-ngx instance

Installation

Manual Installation

  1. Download the latest release from the Releases page
  2. Extract the files into your vault's .obsidian/plugins/obsidian-paperless-link/ folder
  3. Enable the plugin in Obsidian's Community Plugins settings

Configuration

  1. Open Obsidian Settings → Paperless-ngx Integration
  2. Enter your Paperless-ngx instance URL (e.g., https://paperless.example.com)
  3. Enter your API Token (found in Paperless-ngx under Settings → API)
  4. Click "Test Connection" to verify

Usage

Command Palette

  1. Open the command palette (Ctrl/Cmd + P)
  2. Search for "Paperless: Reference Document"
  3. Search and select a document
  4. A reference card will be inserted at your cursor position

Slash Command

  1. Type /paperless in the editor
  2. Select the command from the suggestions
  3. Search and select a document

Reference Cards

Inserted references look like this in your markdown:

```paperless-reference
{
    "documentId": 123,
    "title": "Invoice 2024",
    "created": "2024-01-15",
    "url": "https://paperless.example.com/documents/123"
}
```

In preview mode, this renders as a clickable card showing the document thumbnail, title, and date. Clicking the card opens the document in Paperless-ngx.

Requirements

  • Obsidian v0.15.0 or higher
  • A running Paperless-ngx instance with API access

License

Apache License 2.0

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.