apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-04-25 00:36:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: enhance Obsidian connector installation instructions and add BRAT installation method

Browse source
This commit is contained in:
Anish Sarkar 2026-04-22 17:34:27 +05:30
parent 3eb4d55ef5
commit 1d324f169f
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
surfsense_web/content/docs/connectors/obsidian.mdx
View file

@ -25,13 +25,23 @@ This works for cloud and self-hosted deployments, including desktop and mobile c
## Quick start ## Quick start
1. Open **Connectors** in SurfSense and choose **Obsidian**. 1. Open **Connectors** in SurfSense and choose **Obsidian**.
2. Click **Open plugin releases** and install the latest SurfSense Obsidian plugin. 2. Install the plugin (recommended via BRAT) using the steps below.
3. In Obsidian, open **Settings → SurfSense**. 3. In Obsidian, open **Settings → SurfSense**.
4. Paste your SurfSense API token from the user settings section. 4. Paste your SurfSense API token from the user settings section.
5. Paste your Server URL in the plugin setting: either your SurfSense main domain (if `/api/v1` rewrites are enabled) or your direct backend URL. 5. Paste your Server URL in the plugin setting: either your SurfSense main domain (if `/api/v1` rewrites are enabled) or your direct backend URL.
6. Choose the Search Space in the plugin, then the first sync should run automatically. 6. Choose the Search Space in the plugin, then the first sync should run automatically.
7. Confirm the connector appears as **Obsidian - <vault>** in SurfSense. 7. Confirm the connector appears as **Obsidian - <vault>** in SurfSense.
## Install via BRAT (recommended)
1. In Obsidian, open **Settings → Community plugins** and install **BRAT**.
2. Open BRAT settings and click **Add beta plugin** button.
3. Paste the repository: `https://github.com/modsetter/SurfSense/`.
4. Select the latest plugin version, then enable **SurfSense**.
5. Open **Settings → SurfSense** to finish setup.
If BRAT is unavailable in your environment, use **Open plugin releases** in SurfSense and install manually from GitHub release assets.
## Migrating from the legacy connector ## Migrating from the legacy connector
If you previously used the legacy Obsidian connector architecture, migrate to the plugin flow: If you previously used the legacy Obsidian connector architecture, migrate to the plugin flow: