Inoreader Sync

Sync highlights, annotations, and articles from Inoreader into your Obsidian vault.

Features

• Sync annotated articles -- articles you've highlighted or annotated in Inoreader get their own markdown files with highlights as blockquotes and notes as plain text
• Sync by tag -- select which Inoreader tags to sync; each tag gets its own subfolder
• Periodic note integration -- optionally append or prepend article entries to your daily, weekly, monthly, quarterly, or yearly notes with an optional heading
• Incremental sync -- only fetches new articles since your last sync, with rate limit detection
• Customizable templates -- configure article file and periodic note entry templates with Handlebars-like syntax
• Configurable frontmatter -- choose which metadata fields to include (title, author, URL, published date, feed, tags)
• Duplicate detection -- tracks synced article IDs and highlight IDs to prevent duplicates across re-syncs
• Full article content -- optionally include the full article body converted from HTML to markdown

Requirements

• An Inoreader account
• An Inoreader developer application (Client ID and Client Secret) -- create one at Inoreader Developer Console
• Inoreader Pro plan for annotation/highlight support

Setup

1. Install the plugin from Obsidian's Community Plugins browser
2. Create an Inoreader developer application at the Inoreader Developer Console
   • Set the redirect URI to http://localhost:42819/callback
   • Inoreader normally requires HTTPS but allows http:// for localhost. The plugin runs a short-lived local server on this port to catch the OAuth callback — the authorization code is exchanged between your browser and your machine, with no third-party in the loop.
3. Open the plugin settings in Obsidian
4. Enter your Client ID and Client Secret
5. Click "Connect" and complete the OAuth flow in your browser
6. Configure which articles to sync (annotated, tagged, or both)
7. Click "Sync" or use the ribbon icon to trigger your first sync

How the OAuth flow works

When you click Connect, the plugin opens Inoreader's authorization page in your browser. After you authorize, Inoreader redirects back to whichever URL is set in Redirect URI. The plugin handles four URL shapes:

• http://localhost:PORT/callback (default): desktop only. The plugin spins up a short-lived local HTTP server on that port, waits for one callback, then shuts down. The 5-minute timeout guards against an abandoned flow.
• obsidian://inoreader-sync-auth: Obsidian's protocol handler fires directly. Only useful for users whose Inoreader app was registered before the HTTPS-only policy took effect.
• https://…/inoreader-obsidian/…: a "bouncer" URL hosted on a github.io site whose page issues an obsidian:// navigation. The plugin just opens the browser and lets the protocol handler fire.
• Anything else (https://…): the plugin opens a modal in Obsidian where you paste the redirect URL after your browser fails to load it. Useful for self-hosted setups.

On mobile (where no local server can run), the localhost default automatically falls back to the paste-modal flow.

Upgrading from 0.18.0 or earlier

The redirect URI default changed in 0.18.1. Previously the plugin used obsidian://inoreader-sync-auth, but Inoreader's developer console now rejects custom URI schemes for new app registrations (#1).

If your existing Inoreader app registration with obsidian://inoreader-sync-auth is still working, you have two options:

• Keep the old setup: open plugin settings and set "Redirect URI" back to obsidian://inoreader-sync-auth. The plugin will keep using Obsidian's protocol handler directly.
• Switch to the new default: edit your Inoreader app at the developer console, change its redirect URI to http://localhost:42819/callback, then reconnect from plugin settings.

Folder structure

Synced articles are organized under your configured output folder (default: Inoreader/):

Inoreader/
  Annotations/
    Article Title.md
  Tags/
    Tag Name/
      Another Article.md

Template variables

Article files

{{title}}, {{author}}, {{url}}, {{feed_title}}, {{feed_url}}, {{published_date}}, {{highlights}}, {{content}}, {{highlight_count}}, {{tags}}, {{frontmatter}}, {{id}}

Periodic note entries

{{title}}, {{url}}, {{author}}, {{feed_title}}, {{published_date}}, {{highlight_count}}, {{tags}}, {{id}}

Use {{#each highlights}}...{{/each}} to iterate highlights, with {{this.text}}, {{this.note}}, {{this.id}}, {{this.addedOn}} inside the loop. Use {{#if variable}}...{{/if}} for conditional sections.

Commands

• Sync -- fetch new annotations and tagged articles
• Full resync -- re-fetch and rewrite all articles (use after changing templates or settings)
• Connect -- start the OAuth authentication flow
• Disconnect -- clear stored credentials

License

MIT