Settings Guide

When enabled, closing the window minimizes to system tray instead of quitting the app.

• Useful for auto-sync and keeping the KOReader API server running
• Access the app from the system tray icon
• Right-click tray icon to fully quit

Masks sensitive file paths and data in the UI and error messages for screen sharing or recording.

• Hides Obsidian vault paths, API URLs, and database paths
• Useful when creating tutorials or sharing screenshots

Automatically launch Unearthed when you log into your computer.

• Windows: Managed via in-app toggle
• macOS: Use Dock → Options → Open at Login (no in-app setting)
• Linux: Creates .desktop file in ~/.config/autostart/

Register system-wide keyboard shortcuts so Unearthed responds even when the app is minimized or another application is in focus.

• Unlocks Quick Import (Ctrl/Cmd+Shift+I) and Go to RSS Feeds (Ctrl/Cmd+Shift+O) from any app
• macOS: Accessibility permissions required — grant in System Preferences → Privacy & Security → Accessibility
• If a shortcut conflicts with another app, reassign it in Settings → Keyboard Shortcuts
• Works best combined with Keep App Running in Background

macOS only. When disabled, the app runs solely from the menu bar without a Dock icon.

• Automatically enables 'Keep App Running in Background' when disabled
• The tray/menu bar icon is used to access the app instead
• This setting only appears on macOS

Click any shortcut in the list to remap it. Press your desired key combination (including modifier keys like Ctrl, Shift, or Alt) and save.

• Open via Settings → Keyboard Shortcuts, or press Ctrl/Cmd + /
• Supports modifier combinations: Ctrl/Cmd, Shift, Alt
• Changes apply instantly — no restart required
• Custom bindings are persisted across sessions in settings.json
• Use 'Reset' to restore any shortcut to its default binding

Secure HTTPS endpoint for KOReader e-readers and the Unearthed iOS app. iOS requires HTTPS and a trusted certificate.

• Format: https://[IP_ADDRESS]:6543
• Copy button available next to each URL
• iOS users: download and trust the certificate shown in Settings before connecting
• KOReader users: use this port and URL in the Unearthed plugin settings

Plain HTTP endpoint for Android devices. Android Chrome blocks self-signed HTTPS certificates, so this separate port avoids the certificate trust step entirely.

• Format: http://[IP_ADDRESS]:6545
• In the Unearthed mobile app on Android, enter port 6545 (not 6543)
• No certificate installation required on Android

Authentication token that KOReader and the mobile app must provide to connect.

• Can be any text you choose
• Must match exactly in KOReader plugin settings and the mobile app
• Use the Generate button to create a secure random token
• Leave empty to disable authentication (not recommended)

The folder where your Obsidian vault is located. This is where the Root Folder will be created.

• Use the Browse button to select your vault folder
• Must have write permissions to this location
• Can be any folder, doesn't have to be an Obsidian vault

The main folder name created inside your vault location where all books will be organized.

• Books are organized as: [Location]/[Root Folder]/Books/
• Articles go in: [Location]/[Root Folder]/Articles/
• Change this to match your vault structure

Automatically export all highlights and notes to your Obsidian vault every hour.

• Requires an Obsidian vault location to be configured
• Only new or changed highlights are written on each export (smart export)
• Runs alongside Auto Fetch from Kindle for a fully automated pipeline

When enabled, the full article content is exported alongside your quotes and notes when exporting articles to Obsidian.

• Only applies to articles (RSS / Web Page imports), not Kindle books
• Disabled by default — enable if you want a full local copy of article text in your vault
• Article content is appended after the quotes section in the exported Markdown file

The date format used for your Obsidian daily note filenames. Supports full moment.js-compatible token replacement.

• Tokens: YYYY, YY, MMMM, MMM, MM, M, DD, D, Do, dddd, ddd, dd, d, DDD, DDDD, w, ww, W, WW, E, e, Q
• Slashes create subfolders: YYYY/MM-MMMM/YYYY-MM-DD-dddd → 2025/02-February/2025-02-10-Monday
• Escaped literals: [Week] WW → Week 06
• Must match your Obsidian daily notes plugin settings

The folder where your Obsidian daily notes are stored.

• Use Browse button to select the folder
• Typically something like: YourVault/Daily Notes/
• Must match your Obsidian daily notes plugin folder

Automatically create a daily note file if one doesn't exist for today.

• When disabled, Unearthed waits for you to create the note manually
• When enabled, creates the file immediately on startup

Automatically append a random quote to your daily note when the app starts.

• Works together with 'Create Daily Note' setting
• If both are disabled, no automatic reflection is added
• If 'Create' is off but 'Add' is on, waits for manual note creation

Optional. Insert daily reflections under a specific markdown heading instead of appending at the end of the file.

• Example: ### Daily Reflection
• Finds the heading in your daily note and inserts content below it
• If the heading is not found, falls back to appending at the end
• Respects heading hierarchy — content is placed before the next same-level heading

The URL where you'll log into Amazon to sync Kindle highlights.

• Default works for most users
• Change to your regional Amazon domain if needed (e.g., amazon.co.uk)
• This is where the in-app browser navigates when establishing connection

Automatically fetch new highlights from Kindle every hour in the background.

• Requires 'Keep App Running' to be enabled
• Syncs silently without interrupting your work
• Manual sync always available via 'Refresh Kindle Books' button

Automatically remove unimported RSS articles that are older than the specified number of days to keep your feed tidy.

• Set to 0 to keep all articles indefinitely
• Only articles you have NOT imported are deleted — anything saved to your library is kept forever
• Applies to all subscribed feeds
• Articles are deleted silently in the background

Template for generating Markdown filenames from book metadata.

• Available variables: {{title}}, {{subtitle}}, {{author}}, {{type}}, {{origin}}, {{asin}}
• Example: '{{title}} - {{author}}' → 'Atomic Habits - James Clear.md'
• Keep it simple to avoid filesystem issues

Character to replace spaces with in generated filenames.

• Common options: space ' ', underscore '_', dash '-'
• Use underscore for wiki-link compatibility
• Leave as space for human-readable names

Convert all filenames to lowercase.

• Useful for consistent naming across platforms
• Example: 'Atomic Habits.md' → 'atomic habits.md'

When exporting to CSV, include books marked as 'ignored' in a separate 'Ignored' subfolder.

• Ignored books are excluded from Obsidian export by default
• This setting only affects CSV exports

How highlight colors are displayed in exported Markdown files.

• none: No color styling applied
• background: Gradient background behind text
• text: Colored text only

Displays the full file path to your local SQLite database.

• Useful for manual backups or inspection
• Location varies by platform (AppData on Windows, Application Support on macOS)

Permanently removes all locally stored books and quotes.

• ⚠️ This action cannot be undone
• Requires double confirmation
• Use this to start fresh or troubleshoot corruption issues
• You can re-sync from Kindle/KOReader after deletion