Files
f0ckm-uploader/browser-extension/README.md

59 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# f0ckm Browser Integration Addon
A ShareX-style browser extension for **Chrome, Brave, Edge, Opera, and Firefox** that allows you to upload images, media, links, and URLs directly to **f0ckm** from any web browser context menu or toolbar popup.
---
## Features
- **Right-Click Context Menu (ShareX Style)**:
- **Upload image to f0ckm** (on any image)
- **Upload media to f0ckm** (on video/audio elements)
- **Upload link with f0ckm** (on links)
- **Upload selected URL with f0ckm** (on highlighted text URLs)
- **Upload page URL to f0ckm** (on page background)
- **Dual Upload Modes**:
- **Desktop App Mode (`f0ckm://`)** *(Recommended)*: Hands off downloads and uploads to the KDE desktop system tray app. Gives you live system tray digit progress (`0``99`%), Spectacle notifications, audio sounds, and local history gallery.
- **Direct API Mode**: Uploads directly from the browser background page using API URL and API Key without needing the tray app running.
- **Toolbar Popup Interface**:
- Upload current active tab URL with one click.
- Paste any URL for quick upload.
- Quick toggle between Desktop App Mode and Direct API Mode.
- **Global Keyboard Shortcut**: `Alt+Shift+U` to immediately upload current page URL.
---
## Installation Instructions
### Chrome, Brave, Edge, Opera (Chromium)
1. Open your browser and navigate to `chrome://extensions` (or `edge://extensions` in Edge).
2. Enable **Developer mode** (toggle in the top-right corner).
3. Click **Load unpacked** in the top-left menu.
4. Select the `browser-extension` folder in this repository (`/home/kibi/Projects/f0ckm-uploader/browser-extension`).
5. Pin the **f0ckm Uploader** icon to your toolbar for easy access!
### Mozilla Firefox
1. Open Firefox and navigate to `about:debugging#/runtime/this-firefox`.
2. Click **Load Temporary Add-on...**
3. Select `manifest.json` from the `browser-extension` folder.
---
## Usage
1. **Right-Click Context Menu**: Right-click any image, video, audio link, or page -> select **Upload to f0ckm**.
2. **Toolbar Popup**: Click the f0ckm icon in your browser toolbar to upload the active tab or paste a URL.
3. **Keyboard Shortcut**: Press `Alt+Shift+U` on any tab.
---
## Configuration
Click **Settings** (or right-click extension icon -> Options) to configure:
- **Upload Mode**: Desktop App (f0ckm://) vs Direct API.
- **API Endpoint URL**: Default `https://your-f0ckm-instance.com/api/v2/upload`.
- **API Key**: Secret API key for direct API mode.
- **Default Rating / Tags / Visibility / OC / Copied Link Format**.