Repository navigation
Releases
Releases · ItsAnhReal/obsidian-paperless-sync
0.2.0
Paperless Sync 0.2.0 brings search, new commands, tag filters and more control over what ends up in your vault.
New commands
- Search documents: full text search of Paperless-ngx from the command palette. Opens the chosen document's note and creates it first if needed.
- Insert link to document: the same search, but inserts a link to the document's note at the cursor.
- Open document in Paperless-ngx: opens the document of the current note.
- Sync this note: refreshes just the note that is open.
- Show notes of removed documents: lists notes flagged
paperless_missingand can move them to a folder for removed documents. Links to them are updated.
New settings
- Only documents with these tags / Skip documents with these tags: choose which documents get a note. A skipped tag always wins. Existing notes of skipped documents are kept and no longer updated. Filter tags that don't exist in Paperless-ngx are named in the sync result.
- Document text: choose Do not sync (default), Only documents with the tag below or All documents. Text is only downloaded again when the document changed, and Do not sync removes existing text sections. A 0.1.0 setup with a document text tag switches to the tagged mode automatically.
- Include Paperless-ngx notes: the notes written on a document in Paperless-ngx go into a collapsed section of its Obsidian note. Turning it off removes those sections again.
New property
paperless_modified: when the document was last changed in Paperless-ngx.
Good to know
The first sync after updating rewrites every Paperless note once to add paperless_modified. iCloud, Obsidian Sync and similar tools will upload all Paperless notes once; after that, syncs are quiet again.
0.1.0
First public release of Paperless Sync: your Paperless-ngx archive as notes in Obsidian.
Features
- One note per document with title, correspondent, document type, tags, dates, ASN, storage path and custom fields as Obsidian properties.
- Read-only: the plugin only sends
GETrequests and never changes anything in Paperless-ngx. Notes are never deleted; documents that disappear getpaperless_missing: true. - Your notes stay yours: only the
paperless_*properties are managed. Notes are matched bypaperless_id, so you can rename and move them freely. - Document text only when you opt in: give documents a tag of your choice and only those get their text in a collapsed section of their note.
- Automatic sync at startup and on an interval, and quiet writes: unchanged notes are never touched.
- Token in secret storage: the API token is stored on the device, never in the vault.
Requirements
- Obsidian 1.13.2 or newer, desktop only (macOS, Windows, Linux). Notes reach your phone through your usual vault sync.
- A Paperless-ngx instance and an API token.
See the README for setup.