Simplify README and install instructions
This commit is contained in:
@@ -23,10 +23,6 @@ LOG_LEVEL=INFO
|
|||||||
CHUNKED_UPLOADS_ENABLED=true
|
CHUNKED_UPLOADS_ENABLED=true
|
||||||
CHUNK_SIZE_MB=50
|
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
|
# Optional Telegram bot for upload alerts and control
|
||||||
# create a bot using @BotFather then copy the API key here
|
# create a bot using @BotFather then copy the API key here
|
||||||
# get your account's ID by messaging https://t.me/userinfobot
|
# get your account's ID by messaging https://t.me/userinfobot
|
||||||
|
|||||||
11
Dockerfile
11
Dockerfile
@@ -1,7 +1,7 @@
|
|||||||
# syntax=docker/dockerfile:1.7
|
# syntax=docker/dockerfile:1.7
|
||||||
FROM python:3.11-slim
|
FROM python:3.11-slim
|
||||||
|
|
||||||
WORKDIR /image_drop
|
WORKDIR /file_drop
|
||||||
|
|
||||||
ENV PYTHONDONTWRITEBYTECODE=1 \
|
ENV PYTHONDONTWRITEBYTECODE=1 \
|
||||||
PYTHONUNBUFFERED=1
|
PYTHONUNBUFFERED=1
|
||||||
@@ -12,17 +12,12 @@ RUN pip install --no-cache-dir -r requirements.txt \
|
|||||||
&& pip install --no-cache-dir python-multipart
|
&& pip install --no-cache-dir python-multipart
|
||||||
|
|
||||||
# Copy app code
|
# 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)
|
# Defaults (can be overridden via compose env)
|
||||||
ENV HOST=0.0.0.0 \
|
ENV HOST=0.0.0.0 \
|
||||||
PORT=8080 \
|
PORT=8080 \
|
||||||
STATE_DB=/image_drop/data/state.db
|
STATE_DB=/file_drop/data/state.db
|
||||||
|
|
||||||
EXPOSE 8080
|
EXPOSE 8080
|
||||||
|
|
||||||
|
|||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
MIT License
|
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
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
157
README.md
157
README.md
@@ -1,7 +1,9 @@
|
|||||||
# File Drop Uploader
|
# File Drop Uploader
|
||||||
|
|
||||||
A tiny web app for collecting photos/videos and saving them to the local filesystem.
|
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.
|
||||||
|
|
||||||
|
Forked from "Immich Drop Uploader": https://github.com/Nasogaa/immich-drop
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -13,99 +15,53 @@ Admin users log in to create public invite links; invite links are always public
|
|||||||
- **Passwords (optional):** Protect invites with a password gate.
|
- **Passwords (optional):** Protect invites with a password gate.
|
||||||
- **Albums:** Upload into a specific folder (auto-create supported). Preserves client-side folder structure on upload.
|
- **Albums:** Upload into a specific folder (auto-create supported). Preserves client-side folder structure on upload.
|
||||||
- **Duplicate Prevention:** Local SHA‑1 cache prevents re-uploading the same file.
|
- **Duplicate Prevention:** Local SHA‑1 cache prevents re-uploading the same file.
|
||||||
- **Telegram Notifications:** Get notified via Telegram when upload batches are complete.
|
- **Telegram Notifications (optional):** Get notified via Telegram when upload batches are complete.
|
||||||
- **Progress Queue:** WebSocket updates; see upload progress in real-time.
|
- **Progress Queue:** WebSocket updates; see upload progress in real-time.
|
||||||
- **Chunked Uploads (optional):** Large-file support with configurable chunk size.
|
- **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
|
## 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
|
```yaml
|
||||||
version: "3.9"
|
|
||||||
|
|
||||||
services:
|
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
|
restart: unless-stopped
|
||||||
|
|
||||||
# Configure all settings here (no .env required)
|
|
||||||
environment:
|
|
||||||
|
|
||||||
# Optional behavior
|
|
||||||
PUBLIC_UPLOAD_PAGE_ENABLED: "false" # keep disabled by default
|
|
||||||
PUBLIC_BASE_URL: https://drop.example.com
|
|
||||||
|
|
||||||
# Telegram Bot for notifications (optional)
|
|
||||||
#TELEGRAM_BOT_API_KEY: "YOUR_BOT_API_KEY"
|
|
||||||
#TELEGRAM_BOT_OWNER_ID: "YOUR_TELEGRAM_USER_ID"
|
|
||||||
|
|
||||||
# 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:
|
ports:
|
||||||
- 8080:8080
|
- "8080:8080"
|
||||||
|
env_file:
|
||||||
# Persist local dedupe cache (state.db) across restarts
|
- .env
|
||||||
volumes:
|
volumes:
|
||||||
- immich_drop_data:/data
|
- ./data:/file_drop/data
|
||||||
|
- /mnt/example/file-drop:/file_drop/data/uploads
|
||||||
# Simple healthcheck
|
|
||||||
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
|
interval: 30s
|
||||||
timeout: 5s
|
timeout: 5s
|
||||||
retries: 3
|
retries: 3
|
||||||
start_period: 10s
|
start_period: 10s
|
||||||
|
|
||||||
volumes:
|
|
||||||
immich_drop_data:
|
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
|
||||||
### CLI
|
|
||||||
```bash
|
```bash
|
||||||
docker compose pull
|
$ sudo docker compose up --build -d
|
||||||
docker compose up -d
|
|
||||||
```
|
```
|
||||||
---
|
|
||||||
|
|
||||||
## Chunked Uploads
|
### Chunked Uploads
|
||||||
|
|
||||||
- Enable chunked uploads by setting `CHUNKED_UPLOADS_ENABLED=true`.
|
- Chunked uploads are enabled by default. Uses 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.
|
- Configure chunk size with `CHUNK_SIZE_MB` (default: `50`). The client only uses chunked mode for files larger than this.
|
||||||
- Intended to bypass upstream proxy limits (e.g., 100MB) while preserving duplicate checks, EXIF timestamps, album add, and per‑item progress via WebSocket.
|
- Intended to bypass upstream proxy limits (e.g., 100MB) while preserving duplicate checks, EXIF timestamps, album add, and per‑item progress via WebSocket.
|
||||||
|
|
||||||
---
|
## Developtment
|
||||||
|
|
||||||
## Architecture
|
### Architecture
|
||||||
|
|
||||||
- **Frontend:** static HTML/JS (Tailwind). Drag & drop or "Choose files", queue UI with progress and status chips.
|
- **Frontend:** static HTML/JS (Tailwind). Drag & drop or "Choose files", queue UI with progress and status chips.
|
||||||
- **Backend:** FastAPI + Uvicorn.
|
- **Backend:** FastAPI + Uvicorn.
|
||||||
@@ -114,43 +70,11 @@ docker compose up -d
|
|||||||
- 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:** A local SQLite database (`state.db`) prevents re‑uploads across sessions. Uploaded files are stored in `/data/uploads`.
|
||||||
|
|
||||||
---
|
### 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
|
- **Python** 3.11
|
||||||
|
|
||||||
---
|
### Local dev quickstart
|
||||||
# Local dev quickstart
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
Run with live reload:
|
Run with live reload:
|
||||||
|
|
||||||
@@ -160,9 +84,7 @@ python main.py
|
|||||||
|
|
||||||
The backend contains docstrings so you can generate docs later if desired.
|
The backend contains docstrings so you can generate docs later if desired.
|
||||||
|
|
||||||
---
|
### Dev Configuration (.env)
|
||||||
|
|
||||||
## Dev Configuration (.env)
|
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
# Server (dev only)
|
# Server (dev only)
|
||||||
@@ -193,12 +115,9 @@ CHUNK_SIZE_MB=95
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
You can keep a checked‑in `/.env.example` with the keys above for onboarding.
|
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.
|
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**.
|
2. **De-dupe (local)** – Server computes **SHA‑1** and checks `state.db`. If seen, marks as **duplicate**.
|
||||||
@@ -207,24 +126,10 @@ You can keep a checked‑in `/.env.example` with the keys above for onboarding.
|
|||||||
5. **Progress** – Backend streams progress via WebSocket to the same session.
|
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.
|
6. **Privacy** – The UI shows only the current session's items. It does not provide a way to browse saved files.
|
||||||
|
|
||||||
---
|
### Security notes
|
||||||
|
|
||||||
## Security notes
|
|
||||||
|
|
||||||
- The menu and invite creation are behind login. Logout clears the session.
|
- The menu and invite creation are behind login. Logout clears the session.
|
||||||
- Invite links are public by URL; share only with intended recipients.
|
- 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 default uploader page at `/` is disabled unless `PUBLIC_UPLOAD_PAGE_ENABLED=true`.
|
||||||
- No browsing of uploaded media; only ephemeral session state is shown.
|
- 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).
|
- 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 for a default landing page.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT.
|
|
||||||
|
|||||||
@@ -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
|
|
||||||
@@ -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:
|
|
||||||
Reference in New Issue
Block a user