README file from
Github简体中文 / English / 日本語 / 한국어 / 繁體中文
If you have any questions, please create an issue, or join the Telegram group for help: https://t.me/obsidian_users
✨ Core Features
- ⬇️ Batch Download: One-click download of web images within notes to local storage.
- ⬇️ Multi-note Batch Download: Download images from all notes in the entire vault with one click.
- ☁️ Batch Upload: Upload local images to remote services, supporting various storage backends:
- Self-hosted Service: Use in conjunction with Custom Image Gateway.
- Cloud Storage: Aliyun OSS, Amazon S3, Cloudflare R2, MinIO, etc.
- General Protocols: WebDAV, Remote Server, Home NAS.
- ☁️ Multi-note Batch Upload: Upload images from all notes in the entire vault with one click.
- ✂️ Image Processing: Supports instant image processing in note properties or body (e.g., blog cover images):
- Proportional Top-Left Fill (Cover)
- Proportional Center Fill (Contain)
- Fixed Dimension Stretch (Stretch)
- Proportional Fit (Fit)
- 📱 Full Platform Support: Windows, MacOS, Linux, Android, iOS.
- 🖱️ Convenient Operation: Supports drag-and-drop and paste for automatic upload.
- 🌍 Multi-language Support: Built-in multi-language packs.
- 🗑️ Clean Unconnected Images: One-click cleanup of local images in the vault that are not linked to any notes.
🗺️ Roadmap
We are continuously improving; here are the future development plans:
- Clean Unconnected Images: One-click cleanup of local images in the vault that are not linked to any notes.
If you have suggestions for improvement or new ideas, feel free to share them with us by submitting an issue—we will carefully evaluate and adopt suitable suggestions.
🚀 Quick Start
-
Install Plugin Open the Obsidian community plugin market, search for Custom Image Auto Uploader, and install.
-
Configure Gateway (Optional) If using a self-hosted image host, please set Upload Settings > API Gateway Address to your Custom Image Gateway address.
Example:
http://127.0.0.1:9000/api/upload -
Configure Authentication Set the API Access Token (Token) to ensure security.
-
Start Service Ensure the remote Custom Image Gateway service is started and accessible.
-
Verification Create a new note, copy an image into it, and check if the upload is successful.
⚙️ Backend Service (API Gateway)
The advanced features of this plugin require the use of Custom Image Gateway.
Custom Image Gateway is a free and open-source image upload gateway tool.
- Project Address: haierkeys/custom-image-gateway
- Deployment Documentation: Please refer to the project homepage for deployment.
☕ Sponsorship & Support
If you find this plugin very useful and want to support its continued development, feel free to buy me a coffee: