README file from
GithubProton Search
Search your Proton Drive files from Obsidian and create small reference notes.
This is an independent project. It is not affiliated with, endorsed by, or sponsored by Proton AG.
Forked from yunusey/obsidian-proton-integration.
What it does
- Sign in to Proton Drive in your browser
- Search files by name or path (local MiniSearch index, no search server)
- Create a markdown note with two properties only:
urlandpath - Open the file in the browser, or on this computer if the Proton Drive app is installed
The plugin does not embed or preview Proton Drive files inside Obsidian.
Install
Until it is on the Obsidian community plugin directory:
- Build the plugin (
npm installthennpm run build). - Copy
main.js,manifest.json, andstyles.cssinto.obsidian/plugins/proton-search/in your vault. - Enable Proton Search in Obsidian settings.
Usage
- Open Settings → Proton Search and click Sign in, or run Sign in to proton drive.
- Complete sign-in in your browser, then return to Obsidian.
- Run Search proton drive files (or click the search ribbon icon) and pick a file.
- Confirm or change the note name (default: the Proton file name).
- A note is created in the Proton Drive folder at the vault root (or another folder you set). Notes are stored flat, with no subfolders.
Each note has only two properties:
url— the file on Proton Drive in the browserpath— afile://link on this computer, if the Proton Drive app folder is found
With the note open, or from the file menu:
- Open proton file in browser
- Open proton file on this computer
Rebuild the search index from settings or with Refresh proton drive search index. Photos are optional and can take a long time.
Privacy
- Session: sign-in data is saved in plugin storage so you stay signed in after restarting Obsidian. You can enable Keep credentials in memory only if you prefer to sign in again each time. Saved credentials are written to
.obsidian/plugins/proton-search/data.json, unencrypted. Do not share this file, and do not add it to version control. - Search index: file names and folder paths are stored locally in
data.json. File contents are not indexed. - Client UID: a random
protonClientUidis stored so the Proton Drive SDK can identify this installation. It is not a credential.
[!CAUTION] The Proton Drive SDK is still evolving and does not yet ship standalone auth. Sign-in follows the same pattern as the official Drive CLI.
Development
npm install
npm run dev
npm run build
npm run typecheck
License
MIT