Obsidian Stats logoObsidian Stats

DocFerry

by Rosetta Zidian Guo
5
4
3
2
1
New Plugin
Install Code

Description

Share just a note to a secure link w/ or w/o password. - This plugin has not been manually reviewed by Obsidian staff.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
0
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

See all version on GitHub

README file from

Github

DocFerry

DocFerry is a free and open-source Obsidian plugin for publishing exactly one note as a secure share link. It is designed to work with DocFerry Cloud by default, including a free quota of 5 active shares, while still allowing users to connect a custom self-hosted server.

Website

one Obsidian note -> one secure share URL

DocFerry is intentionally not a folder publisher, vault publisher, public directory, or digital garden. Readers can only open the document behind the share URL they receive. Internal links are resolved only when the target note has also been published through DocFerry.

Status

This branch standardizes DocFerry for an Obsidian Community plugin submission and the DocFerry Cloud free-quota launch path.

  • Plugin name: DocFerry
  • Plugin ID: docferry
  • Author: Bondie Labs
  • Website: bondie.io/research/docferry
  • License: MIT
  • Obsidian Community payment label posture: Optional payments. The plugin is free to install, but the default DocFerry Cloud/custom server workflow connects to hosted services with provider-controlled quotas, terms, and possible billing.
  • Developer-operated paid features: none implemented in this branch
  • Hosted service mode: anonymous in-plugin DocFerry Cloud connection, 5 active shares included
  • Self-hosted mode: custom DocFerry-compatible server URL and token

What It Does

  • Publish the active Markdown note to DocFerry Cloud or a configured DocFerry-compatible server.
  • Update an existing share link for the current note.
  • Copy the current note's share link.
  • Stop sharing the current note.
  • Import a single DocFerry share URL into the current vault.
  • Show whether linked notes are published, unpublished, ambiguous, or unsupported.
  • Review shared notes from the plugin settings share management area.
  • Upload explicitly referenced local assets for the published note.
  • Capture a bounded Obsidian reading-view HTML and CSS snapshot for the share page.
  • Write local share metadata to frontmatter so the same note can be updated or stopped later.
  • Show account quota status when the selected service supports GET /v0/account.

What It Does Not Do

  • It does not publish folders, full vaults, or a public site.
  • It does not create a searchable public directory.
  • It does not scan unrelated notes for upload.
  • It does not require payment to Bondie Labs.
  • DocFerry Cloud encrypts stored content and sensitive metadata at rest, using blind indexes where matching is needed.
  • It does not connect directly from the plugin to vendor object-storage SDKs.
  • It does not send note content anywhere until you test a connection, publish or update a share, stop a share, check linked-note status, or import a share.

Requirements

  • Obsidian 1.4.0 or later.
  • Desktop Obsidian. The plugin uses desktop-only APIs and is marked isDesktopOnly: true.
  • Cloud mode: click Connect DocFerry Cloud in the plugin. No custom server URL, account login, OAuth flow, or token copy/paste is required.
  • Custom mode: a DocFerry-compatible server URL and API token.

You can self-host the server from this repository. If you use a server operated by someone else, that server operator controls its storage, retention, availability, and terms.

Settings

  • Service mode: Choose DocFerry Cloud or a custom self-hosted server.
  • Connect DocFerry Cloud: Claims a free anonymous Cloud token inside the plugin and stores it locally in this vault's plugin data.
  • Learn: Opens the DocFerry Cloud help page: bondie.io/research/docferry#cloud-token.
  • Advanced token fallback: Lets support or migration users paste a Cloud token manually without making that the normal path.
  • Server token: A token for your custom self-hosted server.
  • Server URL: Shown only in custom mode.
  • Share management: Lists account shares from the selected service, resolves local notes only by each share's server-provided source path, and lets you open notes, copy links, refresh status, stop sharing, or remove stale local records when a matching local note is found.
  • Password by default: Preselects password protection in the publish dialog.
  • Default expiration: Sets the initial expiration option in the publish dialog.
  • Debug logging: Writes limited publish diagnostics to the developer console when enabled.

Privacy

Read PRIVACY.md before publishing sensitive notes. The plugin also links to the public privacy notice from the settings tab, directly under Service mode. In short: Cloud connection sends a random local install ID so the service can issue a free token and apply abuse limits. Publishing sends only the note and explicitly referenced assets you choose to publish, and only to the selected DocFerry service. Share management uses the account share list and direct source-path lookup rather than enumerating every vault file. Copy actions write DocFerry share URLs to the system clipboard. DocFerry Cloud stores note body, object bytes, and sensitive metadata encrypted at rest, with blind indexes for matching fields; the server decrypts data to render share pages and import payloads. Stop sharing revokes the public URL and removes that share's server-side content and non-reused object bytes. Bondie Labs does not receive your vault data when you self-host.

Development

cd plugin
npm ci
npm run build
node --check main.js

Server tests:

cd server
uv run --extra dev pytest

Release Artifacts

An Obsidian release must attach:

  • manifest.json
  • main.js
  • styles.css

The GitHub release tag must match the version in manifest.json.

Sponsors