Pimg

Keep your vault lightweight while storing images securely in the cloud

A powerful Obsidian plugin that automatically uploads your images to GitHub Gists using base64 encoding, keeping your vault size minimal while ensuring your images are always accessible - even in PDF exports!

✨ Features

• 🖼️ Automatic Image Upload - Drag & drop or paste images directly into your notes
• 🔒 Private Storage - Images stored securely in GitHub Secret Gists
• 📄 PDF Export Compatible - Works perfectly with Obsidian's PDF export feature
• ⚡ Lightweight Vault - Only image URLs stored locally, not the actual files
• 🚀 Fast Loading - Images served through Cloudflare Workers CDN
• 🔄 Fallback Support - Automatically saves locally if upload fails
• ⚙️ Highly Configurable - Control paste/drop behavior, progress notifications, and more

🏗️ Architecture Diagram

🛠️ Installation

Step 1: Install the Plugin

1. Open Obsidian Settings
2. Go to Community Plugins
3. Search for "Pimg"
4. Click Install and Enable

Step 2: Deploy the Cloudflare Worker

Option 1: Direct Deploy (Recommended)

1. Click the "Deploy to Cloudflare Workers" button above
2. Authenticate your accounts:
   • Log in with your Cloudflare account if prompted
   • Connect your GitHub account when requested
3. Configure deployment settings:
   • Follow the on-screen instructions to customize your deployment
   • The system will automatically fork the repository to your GitHub account
4. Complete deployment:
   • Click "Deploy" to build and deploy your worker
   • Wait for the deployment to complete (usually takes 1-2 minutes)
5. Copy your worker URL:
   • After successful deployment, you'll see your worker URL in the format: https://pimg.<your-subdomain>.workers.dev
   • Save this URL - you'll need it for the Obsidian plugin configuration

💡 Tip: The deploy button automatically handles repository forking, dependency installation, building, and deployment. No local setup required!

Option 2: Manual (Local) Deploy

1. Clone the worker repository:

   git clone https://github.com/MdSadiqMd/Pimg-Obsidian-Worker.git
   cd Pimg-Obsidian-Worker

2. Install dependencies:

   npm install

3. Authenticate with Cloudflare:

   npx wrangler login

4. Deploy to Cloudflare Workers:

   npm run deploy

   or

   npx wrangler deploy

5. Copy your worker URL
   After deployment, you'll find your public worker URL in the terminal output (e.g., https://pimg.<your-subdomain>.workers.dev). Use this in your Obsidian settings.

Step 3: Create GitHub Personal Access Token

1. Go to GitHub Settings → Developer Settings → Personal Access Tokens
2. Click "Generate new token (classic)"
3. Give it a descriptive name (e.g., "Pimg Obsidian Plugin")
4. Select the gist scope (Full control of gists)
5. Copy the generated token immediately

Step 4: Configure the Plugin

1. Open Obsidian Settings → Community Plugins → Pimg
2. Enter your GitHub Access Token
3. Enter your GitHub Username
4. Enter your Cloudflare Worker URL
5. Configure behavior settings as desired

Usage

1. Paste: Copy an image and paste it into your note with Ctrl/Cmd+V
2. Drag & Drop: Drag image files directly into your editor
3. Automatic: The plugin handles upload and URL generation automatically

License

This project is licensed under the BSD License - see the LICENSE file for more details

---

Made with ❤️ by @MdSadiqMd