add queue functionality to upload many items and update readme to include basic installation guide

This commit is contained in:
2026-08-12 17:14:59 +02:00
parent 35ff9bae5e
commit 43e95c9d3e
6 changed files with 277 additions and 169 deletions

View File

@@ -34,55 +34,34 @@ Ensure the following system dependencies are installed:
---
## Quick Setup & Installation
## Quick Start (3-Step Setup)
### 1. Clone the Repository
Setting up f0ckm Uploader takes less than a minute:
### 1. Run the Automated Installer
```bash
git clone https://git.lat/kibi/f0ckm-uploader
cd f0ckm-uploader
```
### 2. Install Python Dependencies
```bash
pip install PySide6
```
_(Or install via system package manager: `sudo dnf install python3-pyside6` / `sudo apt install python3-pyside6`)_
### 3. Environment Configuration _(Optional)_
You can set up a `.env` file prior to installation, or configure settings later via the GUI:
```bash
cp .env.example .env
```
Edit `.env`:
```env
API_URL=https://your-f0ckm-instance.com/api/v2/upload
API_KEY=your_secret_api_key
DEFAULT_RATING=s
DEFAULT_TAGS=
DEFAULT_VISIBILITY=0
DEFAULT_IS_OC=false
```
### 4. Run the Installer
```bash
chmod +x install.sh
./install.sh
```
The installer will automatically:
### 2. Enter Your API Credentials
1. Copy binaries to `~/.local/bin/f0ckm-uploader-gui` and `~/.local/bin/f0ckm-uploader`.
2. Generate multi-resolution icons (`32x32`, `48x48`, `64x64`, `128x128`, `256x256`) for KRunner & Start Menu compatibility.
3. Register the Dolphin context menu action in `~/.local/share/kio/servicemenus/`.
4. Register the `.desktop` application launchers and rebuild the KDE Plasma cache (`kbuildsycoca6`).
When `./install.sh` finishes, the **f0ckm Uploader Settings** GUI window will open automatically.
- Fill in your **API URL** (e.g. `https://your-f0ckm-site.com/api/v2/upload`)
- Paste your **API Key**
- Click **Test Connection** -> **Save Settings**
### 3. Start Uploading!
- **System Tray**: Click the tray icon to take a screenshot and upload instantly.
- **Dolphin**: Right-click any file -> **Actions** -> **Upload to f0ckm**.
- **Browser**: Install the extension in `browser-extension/` to right-click web media and upload directly.
---
The installer handles dependency checking (PySide6), desktop entry creation, Dolphin context menus, multi-resolution application icons, and system tray startup automatically.
---