Simplify README and install instructions

Co-authored-by: aider (gemini/gemini-2.5-pro) <aider@aider.chat>

.env.example

@@ -23,10 +23,6 @@ LOG_LEVEL=INFO
 CHUNKED_UPLOADS_ENABLED=true
 CHUNK_SIZE_MB=50
 
-# Custom session secrets
-# By default, a random one is generated
-#SESSION_SECRET=SET-A-STRONG-RANDOM-VALUE
-
 # Optional Telegram bot for upload alerts and control
 # create a bot using @BotFather then copy the API key here
 # get your account's ID by messaging https://t.me/userinfobot

Dockerfile

@@ -1,7 +1,7 @@
 # syntax=docker/dockerfile:1.7
 FROM python:3.11-slim
 
-WORKDIR /image_drop
+WORKDIR /file_drop
 
 ENV PYTHONDONTWRITEBYTECODE=1 \
     PYTHONUNBUFFERED=1
@@ -12,17 +12,12 @@ RUN pip install --no-cache-dir -r requirements.txt \
     && pip install --no-cache-dir python-multipart
 
 # Copy app code
-COPY . /image_drop
+COPY . /file_drop
-
-
-# Data dir for SQLite (state.db)
-#RUN mkdir -p /data
-#VOLUME ["/data"]
 
 # Defaults (can be overridden via compose env)
 ENV HOST=0.0.0.0 \
     PORT=8080 \
-    STATE_DB=/image_drop/data/state.db
+    STATE_DB=/file_drop/data/state.db
 
 EXPOSE 8080
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Simon Adams
+Copyright (c) 2025 Simon Adams, Tanner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,198 +1,80 @@
-# Immich Drop Uploader
+# File Drop Uploader
 
-A tiny web app for collecting photos/videos into your **Immich** server.
+A tiny web app for collecting files and media and saving them to the local filesystem.
-Admin users log in to create public invite links; invite links are always public-by-URL. A public uploader page is optional and disabled by default.
+Admin users log in to create public invite links; invite links are always public-by-URL. A public uploader page is optional and enabled by default.
 
-![Immich Drop Uploader Dark Mode UI](./screenshot.png)
+Forked from "Immich Drop Uploader": https://github.com/Nasogaa/immich-drop
+
+![File Drop Uploader Dark Mode UI](./screenshot.png)
 
 ## Features
 
-- **Invite Links:** public-by-URL links for uploads; one-time or multi-use
+- **Local Saving:** All uploaded files are saved to the local filesystem.
-- **Manage Links:** search/sort, enable/disable, delete, edit name/expiry
+- **Invite Links:** Create public-by-URL links for uploads; one-time or multi-use.
-- **Row Actions:** icon-only actions with tooltips (Open, Copy, Details, QR, Save)
+- **Manage Links:** Search/sort, enable/disable, delete, edit name/expiry.
-- **Passwords (optional):** protect invites with a password gate
+- **Passwords (optional):** Protect invites with a password gate.
-- **Albums (optional):** upload into a specific album (auto-create supported)
+- **Albums:** Upload into a specific folder (auto-create supported). Preserves client-side folder structure on upload.
-- **Duplicate Prevention:** local SHA‑1 cache (+ optional Immich bulk-check)
+- **Duplicate Prevention:** Local SHA‑1 cache prevents re-uploading the same file.
-- **Progress Queue:** WebSocket updates; retry failed items
+- **Telegram Notifications (optional):** Get notified via Telegram when upload batches are complete.
-- **Chunked Uploads (optional):** large-file support with configurable chunk size
+- **Progress Queue:** WebSocket updates; see upload progress in real-time.
-- **Privacy-first:** never lists server media; session-local uploads only
+- **Chunked Uploads (optional):** Large-file support with configurable chunk size.
-- **Mobile + Dark Mode:** responsive UI, safe-area padding, persistent theme
+- **Mobile + Dark Mode:** Responsive UI, safe-area padding, persistent theme.
 
----
-
-## Table of contents
-- [Quick start](#quick-start)
-- [New Features](#new-features)
-- [Chunked Uploads](#chunked-uploads)
-- [Architecture](#architecture)
-- [Folder structure](#folder-structure)
-- [Requirements](#requirements)
-- [Configuration (.env)](#configuration-env)
-- [How it works](#how-it-works)
-- [Mobile notes](#mobile-notes)
-- [Troubleshooting](#troubleshooting)
-- [Security notes](#security-notes)
-- [Development](#development)
-- [License](#license)
-
----
 ## Quick start
-You can run without a `.env` file by putting all settings in `docker-compose.yml` (recommended for deploys).
-Use a `.env` file only for local development.
 
-### docker-compose.yml (deploy without .env)
+Clone the repo.
+
+Copy `.env.example` to `.env` and edit.
+
+### docker-compose.yml
+
 ```yaml
-version: "3.9"
-
 services:
-  immich-drop:
+  file-drop:
-    image: ghcr.io/nasogaa/immich-drop:latest
+    build: .
-    pull_policy: always
+    container_name: file-drop
-    container_name: immich-drop
     restart: unless-stopped
-
-    # Configure all settings here (no .env required)
-    environment:
-
-      # Immich connection (must include /api)
-      IMMICH_BASE_URL: https://immich.example.com/api
-      IMMICH_API_KEY: ${IMMICH_API_KEY}
-
-      # Optional behavior
-      IMMICH_ALBUM_NAME: dead-drop
-      PUBLIC_UPLOAD_PAGE_ENABLED: "false"   # keep disabled by default
-      PUBLIC_BASE_URL: https://drop.example.com
-
-      # Large files: chunked uploads (bypass 100MB proxy limits)
-      CHUNKED_UPLOADS_ENABLED: "false"      # enable chunked uploads
-      CHUNK_SIZE_MB: "95"                  # per-chunk size (MB)
-
-      # App internals
-      SESSION_SECRET: ${SESSION_SECRET}
-
-    # Expose the app on the host
     ports:
-      - 8080:8080
+      - "8080:8080"
-
+    env_file:
-    # Persist local dedupe cache (state.db) across restarts
+      - .env
     volumes:
-      - immich_drop_data:/data
+      - ./data:/file_drop/data
-
+      - /mnt/example/file-drop:/file_drop/data/uploads
-    # Simple healthcheck
     healthcheck:
-      test: ["CMD-SHELL", "python - <<'PY'\nimport os,urllib.request,sys; url=f\"http://127.0.0.1:{os.getenv('PORT','8080')}/\";\ntry: urllib.request.urlopen(url, timeout=3); sys.exit(0)\nexcept Exception: sys.exit(1)\nPY"]
+      test: ["CMD-SHELL", "python - <<'PY'\nimport urllib.request,sys\ntry:\n  urllib.request.urlopen('http://localhost:8080/').read(); sys.exit(0)\nexcept Exception:\n  sys.exit(1)\nPY"]
       interval: 30s
       timeout: 5s
       retries: 3
       start_period: 10s
-
-volumes:
-  immich_drop_data:
 ```
 
-```
-### CLI
 ```bash
-docker compose pull
+$ sudo docker compose up --build -d
-docker compose up -d
 ```
----
 
-## What's New
+### Chunked Uploads
 
-### v0.5.0 – Manage Links overhaul
+- Chunked uploads are enabled by default. Uses setting `CHUNKED_UPLOADS_ENABLED=true`.
-- In-panel bulk actions footer (Delete/Enable/Disable stay inside the box)
+- Configure chunk size with `CHUNK_SIZE_MB` (default: `50`). The client only uses chunked mode for files larger than this.
-- Per-row icon actions with tooltips; Save button lights up only on changes
+- Intended to bypass upstream proxy limits (e.g., 100MB) while preserving duplicate checks, EXIF timestamps, album add, and per‑item progress via WebSocket.
-- Per-row QR modal; Details modal close fixed and reliable
-- Auto-refresh after creating a link; new row is highlighted and scrolled into view
-- Expiry save fix: stores end-of-day to avoid off-by-one date issues
 
-Roadmap highlight
+## Developtment
-- We’d like to add a per-user UI and remove reliance on a fixed API key by allowing users to authenticate and provide their own Immich API tokens. This is not in scope for the initial versions but aligns with future direction.
-- The frontend automatically switches to chunked mode only for files larger than the configured chunk size.
 
-### 📱 Device‑Flexible HMI (New)
+### Architecture
-- Fully responsive UI with improved spacing and wrapping for small and large screens.
-- Mobile‑safe file picker and a sticky bottom “Choose files” bar on phones.
-- Safe‑area padding for devices with notches; refined dark/light theme behavior.
-- Desktop keeps the dropzone clickable; touch devices avoid accidental double‑open.
-
-### ♻️ Reliability & Quality of Life (New)
-- Retry button to re‑attempt any failed upload without re‑selecting the file.
-- Progress and status updates are more resilient to late/reordered WebSocket events.
-- Invites can be created without an album, keeping uploads unassigned when preferred.
-
-### Last 8 Days – Highlights
-- Added chunked uploads with configurable chunk size.
-- Added optional passwords for invite links with in‑UI unlock prompt.
-- Responsive HMI overhaul: mobile‑safe picker, sticky mobile action bar, safe‑area support.
-- Retry for failed uploads and improved progress handling.
-- Support for invites with no album association.
-
-### 🌙 Dark Mode
-- Automatic or manual toggle; persisted preference
-
-### 📁 Album Integration
-- Auto-create + assign album if configured; optional invites without album
-
----
-
-## Chunked Uploads
-
-- Enable chunked uploads by setting `CHUNKED_UPLOADS_ENABLED=true`.
-- Configure chunk size with `CHUNK_SIZE_MB` (default: `95`). The client only uses chunked mode for files larger than this.
-- Intended to bypass upstream limits (e.g., 100MB) while preserving duplicate checks, EXIF timestamps, album add, and per‑item progress via WebSocket.
-
----
-
-## Architecture
 
 - **Frontend:** static HTML/JS (Tailwind). Drag & drop or "Choose files", queue UI with progress and status chips.
 - **Backend:** FastAPI + Uvicorn.
-  - Proxies uploads to Immich `/assets`  
+  - Saves uploaded files to the local filesystem.
-  - Computes SHA‑1 and checks a local SQLite cache (`state.db`)  
+  - Computes SHA‑1 and checks a local SQLite cache (`state.db`) to prevent duplicates.
-  - Optional Immich de‑dupe via `/assets/bulk-upload-check`  
+  - WebSocket `/ws` pushes per‑item progress to the current browser session only.
-  - WebSocket `/ws` pushes per‑item progress to the current browser session only  
+- **Persistence:** A local SQLite database (`state.db`) prevents re‑uploads across sessions. Uploaded files are stored in `/data/uploads`.
-- **Persistence:** local SQLite (`state.db`) prevents re‑uploads across sessions/runs.
 
----
+### Requirements
-
-## Folder structure
-
-```
-immich_drop/
-├─ app/                     # FastAPI application (Python package)
-│  ├─ app.py                # ASGI app (uvicorn entry: app.app:app)
-│  └─ config.py             # Settings loader (reads .env/env)
-├─ frontend/                # Static UI (served at /static)
-│  ├─ index.html            # Public uploader (optional)
-│  ├─ login.html            # Login page (admin)
-│  ├─ menu.html             # Admin menu (create invites)
-│  ├─ invite.html           # Public invite upload page
-│  ├─ app.js                # Uploader logic (drop/queue/upload/ws)
-│  ├─ header.js             # Shared header (theme + ping + banner)
-│  └─ favicon.png           # Tab icon (optional)
-├─ data/                    # Local dev data dir (bind to /data in Docker)
-├─ main.py                  # Thin dev entrypoint (python main.py)
-├─ requirements.txt         # Python dependencies
-├─ Dockerfile
-├─ docker-compose.yml
-├─ .env.example             # Example dev environment (optional)
-├─ README.md
-└─ screenshot.png           # UI screenshot for README
-```
-
----
-
-## Requirements
 
 - **Python** 3.11
-- An **Immich** server + **API key**
 
----
+### Local dev quickstart
-# Local dev quickstart
-
-## Development
 
 Run with live reload:
 
@@ -202,29 +84,23 @@ python main.py
 
 The backend contains docstrings so you can generate docs later if desired.
 
----
+### Dev Configuration (.env)
-
-## Dev Configuration (.env)
 
 ```ini
 # Server (dev only)
 HOST=0.0.0.0
 PORT=8080
 
-# Immich connection (include /api)
-IMMICH_BASE_URL=http://REPLACE_ME:2283/api
-IMMICH_API_KEY=ADD-YOUR-API-KEY   # needs: asset.upload; for albums also: album.create, album.read, albumAsset.create
-MAX_CONCURRENT=3
-
 # Public uploader page (optional) — disabled by default
 PUBLIC_UPLOAD_PAGE_ENABLED=TRUE
 
-# Album (optional): auto-add uploads from public uploader to this album (creates if needed)
-IMMICH_ALBUM_NAME=dead-drop
-
 # Local dedupe cache (SQLite)
 STATE_DB=./data/state.db
 
+# Telegram Bot for notifications (optional)
+#TELEGRAM_BOT_API_KEY=
+#TELEGRAM_BOT_OWNER_ID=
+
 # Base URL for generating absolute invite links (recommended for production)
 # e.g., PUBLIC_BASE_URL=https://photos.example.com
 #PUBLIC_BASE_URL=
@@ -239,43 +115,21 @@ CHUNK_SIZE_MB=95
 
 ```
 
-
 You can keep a checked‑in `/.env.example` with the keys above for onboarding.
 
----
+### How it works
 
-## How it works
+1. **Queue** – Files selected in the browser are queued; each gets a client-side ID.
+2. **De-dupe (local)** – Server computes **SHA‑1** and checks `state.db`. If seen, marks as **duplicate**.
+3. **Save** – The file is saved to the local filesystem under `./data/uploads`.
+4. **Album** – If an album is specified via an invite link, or a folder name is provided on the public page, the file is saved into a corresponding subdirectory. Client-side folder structure is also preserved.
+5. **Progress** – Backend streams progress via WebSocket to the same session.
+6. **Privacy** – The UI shows only the current session's items. It does not provide a way to browse saved files.
 
-1. **Queue** – Files selected in the browser are queued; each gets a client‑side ID.  
+### Security notes
-2. **De‑dupe (local)** – Server computes **SHA‑1** and checks `state.db`. If seen, marks as **duplicate**.  
-3. **De‑dupe (server)** – Attempts Immich `/assets/bulk-upload-check`; if Immich reports duplicate, marks accordingly.  
-4. **Upload** – Multipart POST to `${IMMICH_BASE_URL}/assets` with:
-   - `assetData`, `deviceAssetId`, `deviceId`,  
-   - `fileCreatedAt`, `fileModifiedAt` (from EXIF when available; else `lastModified`),  
-   - `isFavorite=false`, `filename`, and header `x-immich-checksum`.  
-5. **Album** – If `IMMICH_ALBUM_NAME` is configured, adds the uploaded asset to the album (creates album if it doesn't exist).  
-6. **Progress** – Backend streams progress via WebSocket to the same session.  
-7. **Privacy** – UI shows only the current session's items. It never lists server media.
-
----
-
-## Security notes
 
 - The menu and invite creation are behind login. Logout clears the session.
 - Invite links are public by URL; share only with intended recipients.
 - The default uploader page at `/` is disabled unless `PUBLIC_UPLOAD_PAGE_ENABLED=true`.
-- The Immich API key remains **server‑side**; the browser never sees it.  
 - No browsing of uploaded media; only ephemeral session state is shown.
 - Run behind HTTPS with a reverse proxy and restrict CORS to your domain(s).
-
-## Usage flow
-
-- Admin: Login → Menu → Create invite link (optionally one‑time / expiry / album) → Share link or QR.  
-- Guest: Open invite link → Drop files → Upload progress and results shown.  
-- Optional: Enable public uploader and set `IMMICH_ALBUM_NAME` for a default landing page.
-
----
-
-## License
-
-MIT.

docker-compose.yml

@@ -1,17 +0,0 @@
-services:
-  image-drop:
-    build: .
-    container_name: image-drop
-    restart: unless-stopped
-    ports:
-      - "8080:8080"
-    env_file:
-      - .env
-    volumes:
-      - ./data:/image_drop/data
-    healthcheck:
-      test: ["CMD-SHELL", "python - <<'PY'\nimport urllib.request,sys\ntry:\n  urllib.request.urlopen('http://localhost:8080/').read(); sys.exit(0)\nexcept Exception:\n  sys.exit(1)\nPY"]
-      interval: 30s
-      timeout: 5s
-      retries: 3
-      start_period: 10s

docker-compose.yml.example

@@ -1,33 +0,0 @@
-services:
-  immich-drop:
-    build: .
-    container_name: immich-drop
-    restart: unless-stopped
-    ports:
-      - "8080:8080"
-
-    environment:
-      #immich drop server ip
-      IMMICH_BASE_URL: https://immich.example.com/api
-      IMMICH_API_KEY: ${IMMICH_API_KEY}
-
-      PUBLIC_BASE_URL: https://drop.example.com
-      #Enable/Disable Public upload page to folder
-      PUBLIC_UPLOAD_PAGE_ENABLED: false
-      IMMICH_ALBUM_NAME: dead-drop
-      # Chunked uploads to bypass 100MB limits (e.g., Cloudflare Tunnel)
-      CHUNKED_UPLOADS_ENABLED: true
-      CHUNK_SIZE_MB: 95
-
-
-    volumes:
-      - immich_drop_data:/data
-    healthcheck:
-      test: ["CMD-SHELL", "python - <<'PY'\nimport urllib.request,sys\ntry:\n  urllib.request.urlopen('http://localhost:8080/').read(); sys.exit(0)\nexcept Exception:\n  sys.exit(1)\nPY"]
-      interval: 30s
-      timeout: 5s
-      retries: 3
-      start_period: 10s
-
-volumes:
-  immich_drop_data: