db123
37e7f918d0
All checks were successful
CI / build (push) Successful in 51s
- Remove container picker UI, keyboard, settings, and ContainerOptions entirely — yt-dlp handles container format automatically - Remove Container field from DownloadJob struct and related references - Extract buildFormatList helper to deduplicate format list building between handleURLInput and handleBackStep - Break runDownload into trackDownloadProgress + handleDownloadCompletion - Add HTTP timeout (30s) to downloadFile helper - Log applyQuota and AddHistory errors instead of discarding - Log nil stepState warnings in all handler entry points - Include job.StderrLog in download failure messages - Add tests for buildFormatList, findFormatByID, determineMediaType, and buildFormatString - Update README with search, DRM fallback, and quota feature docs - Remove unused strings import from keyboard.go
87 lines
3.1 KiB
Markdown
87 lines
3.1 KiB
Markdown
# uptodownbot
|
|
|
|
Telegram bot for downloading media from any site yt-dlp supports.
|
|
|
|
## Features
|
|
|
|
- Download audio, video, or combined audio+video from YouTube, Spotify, SoundCloud, Vimeo, and hundreds more
|
|
- Search support: search YouTube/YouTube Music by name when no URL is provided
|
|
- DRM fallback: automatically searches YouTube when Spotify/DRM-protected content is detected
|
|
- Thumbnail preview with metadata (title, uploader, duration) before download
|
|
- Audio-only sites (Spotify, SoundCloud, YouTube Music, etc.) auto-detect and skip to audio quality selection
|
|
- Multi-step format selection: quality, secondary format (audio/video combine), language
|
|
- Playlist support with paginated entry selection (10 per page, select all, confirm with count)
|
|
- Download progress updates (with speed and ETA)
|
|
- Cancel downloads at any time (terminates yt-dlp process)
|
|
- Per-user quota system (daily, weekly, monthly; 0 = unlimited)
|
|
- User preferences (default audio/video quality, language)
|
|
- Download history with pagination
|
|
- Configurable file size limit (default 50 MB)
|
|
- Cookies support for age-restricted content
|
|
- Proxy support via HTTP_PROXY/HTTPS_PROXY env vars
|
|
- Webhook and polling modes
|
|
- SQLite database for persistence
|
|
|
|
## Commands
|
|
|
|
- `/start` - Show main menu
|
|
- `/download` - Prompt for a download URL
|
|
- `/settings` - Open settings
|
|
- `/help` - Show help text
|
|
- `/history` - View download history
|
|
|
|
You can also send a URL directly to start downloading immediately.
|
|
|
|
## Configuration
|
|
|
|
Copy `.env.example` to `.env` and configure:
|
|
|
|
| Variable | Default | Description |
|
|
| ------------------- | ------------------ | -------------------------------- |
|
|
| `BOT_TOKEN` | (required) | Telegram Bot API token |
|
|
| `HTTP_PROXY` | empty | Outbound HTTP proxy |
|
|
| `HTTPS_PROXY` | empty | Outbound HTTPS proxy |
|
|
| `DB_PATH` | `data/uptodown.db` | SQLite database path |
|
|
| `DOWNLOAD_DIR` | `/tmp/uptodown` | Temporary download directory |
|
|
| `MAX_FILE_SIZE_MB` | `50` | Maximum upload file size in MB |
|
|
| `COOKIES_FILE` | empty | Path to cookies.txt for auth |
|
|
| `TZ` | `UTC` | Timezone |
|
|
| `BOT_ALLOWED_USERS` | empty | Comma-separated allowed user IDs |
|
|
| `BOT_WEBHOOK_URL` | empty | Webhook URL (omit for polling) |
|
|
| `BOT_LISTEN` | `:8080` | Webhook listen address |
|
|
| `BOT_TLS_CERT` | empty | TLS certificate path |
|
|
| `BOT_TLS_KEY` | empty | TLS key path |
|
|
|
|
## Running
|
|
|
|
### Polling mode (default)
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
# edit .env with your BOT_TOKEN
|
|
make run-dev
|
|
```
|
|
|
|
### Webhook mode
|
|
|
|
```bash
|
|
export BOT_WEBHOOK_URL=https://your.domain.com/webhook
|
|
make run-dev
|
|
```
|
|
|
|
### Docker
|
|
|
|
```bash
|
|
make docker-run
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
make build # build binary
|
|
make test # run tests
|
|
make fmt # format code
|
|
make vet # vet code
|
|
make check # fmt + vet
|
|
```
|