obsidian-plugin/gustjose_obsidian-syncthing-manager
1
0
Fork 0
mirror of https://github.com/gustjose/obsidian-syncthing-manager.git synced 2026-07-22 06:40:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
85 commits 3 branches 29 tags 8.5 MiB
TypeScript 86.3%
JavaScript 7.2%
CSS 6.5%
Find a file
Gustavo Carreiro 6ec6fa55df feat: List of Online Devices
2026-02-16 09:18:24 -03:00
.github/workflows Update Workflow 2026-01-13 14:36:54 -03:00
docs/images Update Readme 2026-01-14 22:46:06 -03:00
scripts feat: add support for retrieving and restoring file versions 2026-02-16 08:02:34 -03:00
src feat: List of Online Devices 2026-02-16 09:18:24 -03:00
.editorconfig Inicial Commit 2025-11-22 16:08:06 -03:00
.gitignore feat: add support for retrieving and restoring file versions 2026-02-16 08:02:34 -03:00
.npmrc Inicial Commit 2025-11-22 16:08:06 -03:00
eslint.config.js chore: setup linter rules and release scripts 2025-12-01 08:29:25 -03:00
LICENSE Update Readme 2025-11-22 18:53:02 -03:00
manifest.json 1.2.0 2026-01-24 12:55:16 -03:00
package-lock.json 1.2.0 2026-01-24 12:55:16 -03:00
package.json 1.2.0 2026-01-24 12:55:16 -03:00
README.md Update Readme 2026-01-14 22:46:06 -03:00
styles.css feat: List of Online Devices 2026-02-16 09:18:24 -03:00
tsconfig.json Inicial Commit 2025-11-22 16:08:06 -03:00
versions.json Update 2025-11-29 13:17:31 -03:00

README.md

Plugin Banner

Control, monitor, and visualize your Syncthing synchronization directly inside Obsidian.

Latest Release Total Downloads Last Commit License


Plugin Overview

This plugin acts as a bridge to your local Syncthing API, providing real-time file status, a powerful conflict resolver, and tools to keep your vault healthy across Desktop and Mobile devices.

✨ New in v1.1: Visual Sync

Now you can see exactly what is happening with your files without leaving the editor.

  • Tab Status Icons: Instant feedback on the file you are editing.
    • 🟠 Syncing: Spinning icon indicates the file is being uploaded/downloaded.
    • 🟢 Synced: A checkmark appears briefly when synchronization is complete.
  • Smart History: Know the direction of your data.
    • ↙️ Incoming: Changes received from a remote device.
    • ↗️ Outgoing: Local changes sent to other devices.

🚀 Features

  • Real-Time Monitoring: View your vault status (Synced, Syncing, Disconnected) via the Status Bar or a dedicated Side Panel.
  • Conflict Resolver: Intelligent detection of .sync-conflict files with a side-by-side diff view for safe resolution.
  • Visual File Status: Watch your tabs update in real-time as Syncthing processes your files.
  • .stignore Editor: Manage ignored files (like workspace.json or .DS_Store) directly within Obsidian using built-in templates.
  • History Filter: Keep your activity log clean by hiding system files from the history view.
  • Mobile Optimized: Responsive design built to work perfectly on Android.
  • Localization: Fully translated into 🇺🇸 English, 🇧🇷 Portuguese (BR), and 🇷🇺 Russian.

Quick Start

  1. Install: Use BRAT or download the latest release.
  2. Get API Key: In Syncthing, navigate to Actions > Settings > General and copy the API Key.
  3. Configure: - Open Obsidian Settings > Syncthing Manager.
    • Paste your API Key and click Test Connection.
    • Important: Select your Vault Folder from the dropdown menu to track events.

📱 Android Setup (Critical)

To use this plugin on Android (via Syncthing-Fork or the official app), you must allow local HTTP connections.

[!WARNING] > HTTPS Restriction: Obsidian Mobile cannot connect to self-signed HTTPS certificates on localhost. You must disable HTTPS in the Syncthing App settings. Since the address is restricted to 127.0.0.1, your traffic remains local and secure.

  1. Open Syncthing App > Settings > GUI.
  2. Set GUI Listen Address to 127.0.0.1:8384.
  3. Disable "Use HTTPS for GUI".
    • Note: Ensure you have cleared "GUI Authentication User/Password" fields, otherwise the app may enforce HTTPS.
  4. Restart the Syncthing App.
  5. In Obsidian Plugin Settings, ensure Use HTTPS is toggled OFF.

Features Guide

⚔️ Conflict Resolution

When a sync conflict occurs, a red alert will appear in the Syncthing View.

  1. Click the alert to open the Conflict Resolver.
  2. Select Compare Content for a side-by-side comparison.
  3. Choose:
    • Keep Original: Deletes the conflict file.
    • Use Conflict Version: Overwrites your local file with the remote version.

Conflict Modal

📂 Ignoring Files (.stignore)

Prevent layout issues by ignoring workspace configuration files.

  1. Open Settings > Syncthing Manager > Edit .stignore.
  2. Use "Add Common Patterns" to quickly ignore workspace.json, .obsidian/workspace, or OS files like .DS_Store.

FAQ & Troubleshooting

Q: The tab icon is spinning but never turns green.

  • This usually means Syncthing is still scanning or the file is large. Check the Syncthing GUI web panel for detailed progress.

Q: Plugin status shows "Disconnected".

  • Verify that the Syncthing service is running.
  • Ensure the API Key matches exactly.
  • On Android, double-check that HTTPS is disabled in the Syncthing App.

Q: Is it secure to disable HTTPS on Android?

  • Yes. By setting the GUI Listen Address to 127.0.0.1, access is restricted exclusively to applications running locally on that specific device.

Installation

BRAT (Beta)

  1. Install the BRAT plugin from the Obsidian Community Store.
  2. Add this repository URL: https://github.com/gustjose/obsidian-syncthing-manager.
  3. Enable Syncthing Manager.

Contributing

Contributions are welcome! If you encounter bugs or have feature requests, please open an issue.

  • Build: npm run build
  • Dev: npm run dev

License

This project is licensed under the MIT License.
Copyright © 2025 Gustavo Carreiro.