README file from
GithubCaspee for Obsidian
Sends the notes of the folders you pick to your Caspee brain, so your team and its agents can read them, each with its source. One way only: the plugin never writes into your vault.
What you need
- A Caspee account. The plugin signs in to your company's (or your own) Caspee brain,
such as
unabyss.caspee.ai. Without an account on a brain it does nothing. - Obsidian 1.11.4 or later, on desktop or a phone.
Set up
- Open Settings → Caspee and enter your brain's address.
- Press Sign in. Caspee opens in your browser; sign in there. The browser then opens Obsidian to finish. If it does not (often on a phone or on Linux), copy the code the page shows, press Paste code and paste it.
- Press Pick folders on Caspee and tick the folders to send. Nothing is sent until you have saved a pick.
Your vault is sent as your own (private to you) unless an admin of your brain chooses Send this vault as → The company's vault.
Network use
The plugin talks to one address only: the brain address you enter, over HTTPS. It uses no other service.
What it sends:
- At sign-in, a one-time code, a name for this device (for example "Obsidian on Mac (Notes)") and the plugin's version.
- The vault's name and the paths of its folders (so you can pick them on Caspee), the name of the configuration folder and the templates folder.
- For each Markdown note inside the folders you picked: its path, its text, the time it
was last changed and a SHA-256 hash of its text. Notes outside your picks, the
configuration folder,
.trash, the templates folder, hidden folders, sync conflict copies, Excalidraw drawings and attachments are never sent. Notes over 2 MB are skipped. - Which picked notes were deleted or renamed.
When:
- When Obsidian starts, the plugin compares the notes in your picks with what the brain holds and sends what differs.
- After you edit, create, delete or rename a note, about 30 seconds later.
- When you run Send changes now (command palette, or the button in the settings).
- Every ten minutes, a short check of whether your picks changed on Caspee.
The plugin collects no telemetry and shows no ads. What the brain does with the notes is described in Caspee's privacy policy.
Where things are kept
- The sign-in token is kept in Obsidian's secret storage on this device, never in the
plugin's
data.json(which may sync with your vault). data.jsonkeeps the brain address, the vault's Caspee id, whether the vault was sent as your own or the company's, and when it last sent.
Sign out and disconnect
- Sign out (Settings → Caspee) tells the brain to revoke this device's token and forgets it here. The notes already sent stay on the brain.
- Disconnect on the vault's card in Caspee stops the vault: every device's token for it is revoked and nothing more is sent. The notes already sent stay on the brain unless you choose Disconnect and forget, which also removes them. You can also revoke a device from Caspee's Devices page.
Licence
MIT. See LICENSE.