Skip to content

Installation & Setup

Quick Start

  1. Install: Use BRAT or download the latest release from GitHub.
  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.

BRAT (Beta)

To install the latest beta version:

  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.

Android Setup (Critical)

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

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.

Alternative: Force HTTP (Environment Variable)

If the above method resets or fails, you can force Syncthing to use HTTP using an environment variable.

Side Effect

This may cause the Syncthing Android App's native UI to stop loading (showing a blank screen or loading spinner). However, the background service will still run, and you can access the full Web UI via your browser at http://127.0.0.1:8384.

  1. Go to Settings > Troubleshooting > Environment Variables.
  2. Add the following variable:
    • Key: STGUIADDRESS
    • Value: http://127.0.0.1:8384
  3. Restart the App.
  4. If you need to revert, simply delete this variable.