README file from
GithubEnglish | 中文
obsidian-cloud-attach
Obsidian plugin that connects to OpenList/WebDAV services and object storage (S3), letting you insert cloud files directly into your notes. Free up local space.
Background
- A firm believer in the 'Zero-Attachment' workflow in Obsidian.
- Heavy OpenList user
- Former e-commerce practitioner, zero coding background
- Built entirely with 🦞 (AI-assisted), token consumption: ~95M and counting
Features
- 🌐 WebDAV Protocol — Compatible with OpenList, theoretically supports all WebDAV services (Alist, Synology, QNAP, etc.)
- 🌐 S3 Object Storage — Compatible with Cloudflare R2, theoretically supports AWS and most S3-compatible services
- 📂 Sidebar Browser — Browse cloud directories directly in the Obsidian sidebar
- 📝 One-Click Insert — Click to insert Markdown links; supports single and batch insertion
- ⬆️ Upload Attachments — Upload local attachments to the server and update references, saving local space
- 🔗 Signed URLs — Auto-generate URLs with sign tokens
- 🖼️ Media Preview — Image preview, video/audio playback, document iframe preview
- 👤 Multi-Account — Manage multiple WebDAV/S3 accounts simultaneously
Note: Object storage may not support iframe preview due to provider restrictions. A workaround is to mount object storage via OpenList and use its iframe preview.
Installation
Option 1: Download ZIP
- Click Code → Download ZIP in this repository
- Extract and place in
<vault>/.obsidian/plugins/cloud-attach/
Option 2: Download by Release (recommended)
Visit Releases to download a specific version.
Configuration
Add accounts in plugin settings:
| Field | Description |
|---|---|
| Server URL | OpenList URL |
| Username / Password | WebDAV credentials |
| WebDAV Path | Usually /dav |
| Token | Get from OpenList Settings → Other |
Object storage:
Usage
- Click the sidebar icon to open the cloud file panel
- Browse directories, click a file name to insert a link
- Right-click for more actions (preview, copy, delete)
Insert files into notes:
Upload attachments to server:
Roadmap
- Object storage support (primarily Cloudflare R2)
- Search server files within notes and insert (on hold — no good approach yet)
- Manual trigger to detect and refresh expired sign tokens
- Semi-automatic note attachment upload
- Command palette support (Cmd/Ctrl+P)
- Publish to Obsidian Community Plugins
- File rename and delete support
Changelog
Acknowledgements
Issues and Pull Requests are welcome!