Skip to content

README.md

Latest commit

 

History

History
115 lines (76 loc) · 2.34 KB

README.md

File metadata and controls

115 lines (76 loc) · 2.34 KB

dumpbot

Telegram bot for queuing and processing firmware dumps with a separate ARQ worker.

Link

https://t.me/dumpyarabot

Setup

This bot now has two running parts:

  • the Telegram bot process
  • at least one ARQ worker process for dump jobs

Requirements

  • Python 3.10+
  • Redis
  • uv

Install

uv sync

Configure

Copy .env.example to .env and set the values you need:

TELEGRAM_BOT_TOKEN=...
ALLOWED_CHATS=[-1001234567890]
REQUEST_CHAT_ID=-1001234567890
REVIEW_CHAT_ID=-1001234567891
REDIS_URL=redis://localhost:6379/0
SUDO_USERS=[]

REDIS_URL is required because both the bot and the worker use Redis for queueing and state.

Custom scratch directory

By default, each dump job creates a temporary working directory under the system tempdir (typically /tmp). On hosts where the main disk is space-constrained, point this at a bigger mounted disk:

WORK_DIR_BASE=/mnt/big-disk/dumpbot-work

The directory must already exist and be writable by the worker user. If WORK_DIR_BASE is set but the path is missing or not a directory, the job fails fast — there is no silent fallback to /tmp.

Per-job subdirectories are auto-deleted when the job ends (success or failure), same as before.

Out of scope for WORK_DIR_BASE — these paths are not moved:

  • ~/Firmware_extractor — alt-dumper clone in $HOME.
  • ~/dumpbot/whitelist.txt — read-only whitelist.
  • uvx cache — governed by uv / XDG_CACHE_HOME.
  • The systemd WorkingDirectory — process CWD only, not dump payloads.
  • extract_and_push.sh — not on the ARQ job path; uses CWD when run standalone.

Run

Start Redis first, then run the worker and bot in separate terminals.

Start one worker

python run_arq_worker.py

You can also use the ARQ CLI:

arq worker_settings.WorkerSettings

Start the bot

python -m dumpyarabot

Commands

/dump [URL] [options]

Queue a new firmware dump job.

Options:

  • a use the alternative dumper
  • f force a new dump even if one exists

Examples:

  • /dump https://example.com/firmware.zip
  • /dump https://example.com/firmware.zip a
  • /dump https://example.com/firmware.zip f
  • /dump https://example.com/firmware.zip af

/cancel [job_id]

Cancel an active dump job.

Example:

  • /cancel 123

/status

Show queue or job status.