HKML-X Docs

Appearance

Quick Start ​

Get the bot running and send your first file — in about 10 minutes.

Step 1: Collect the 5 things you need ​

Open these in browser tabs and grab the info:

WhatWhere to find it
Bot Token@BotFather → send /newbot → choose a name → copy the token
API ID + Hashmy.telegram.org → log in → copy both numbers
Your User ID@userinfobot → send /start → it shows a number
MongoDB URLMongoDB Atlas → free account → create cluster → click Connect → copy the connection string
A serverAny VPS with Docker (DigitalOcean $6/mo, Hetzner, Vultr)

Don't have a server? Get the cheapest VPS from any provider. A $6/month plan works fine.

Step 2: Connect to your server ​

bash
ssh root@your-server-ip

Step 3: Install Docker ​

bash
curl -fsSL https://get.docker.com | sh

Step 4: Download and configure the bot ​

bash
git clone -b wzv3 https://github.com/Imkrishana/HKML-X.git
cd HKML-X
cp config_sample.py config.py
nano config.py

Do not skip the cp line. If config.py doesn't exist when you start Docker, Docker makes a folder named config.py and the bot crashes with a confusing error.

Find these 5 lines and fill them in:

python
BOT_TOKEN = "1234567890:ABCdefGHIjklmNOPqrstUVwxyz-1234567"   # from BotFather
OWNER_ID = 123456789                                            # from userinfobot
TELEGRAM_API = 12345                                            # from my.telegram.org
TELEGRAM_HASH = "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p"            # from my.telegram.org
DATABASE_URL = "mongodb+srv://user:pass@cluster0.xxxxx.mongodb.net"  # from MongoDB Atlas

Save: Ctrl+S (or Ctrl+O then Enter). Exit: Ctrl+X.

Step 5: Start the bot ​

bash
docker compose up -d --build

The first build takes 5-15 minutes. After that, starts take seconds. Check it's running:

bash
docker compose ps

Both app and tunnel should show Up. To see the startup logs:

bash
docker compose logs app --tail 10

Step 6: Open Telegram and talk to your bot ​

Search for the username you chose on @BotFather. Send:

/start

You should see a welcome message. If you get "not authorized", send /login followed by the LOGIN_PASS if you set one.

Step 7: Your first file ​

No setup needed. Copy-paste this exact command:

/leech https://speed.hetzner.de/100MB.bin

Wait 10-30 seconds...

The bot will send you a file called 100MB.bin. Tap it to download.

You just sent your first file through the bot!

Step 8: /mirror needs a cloud drive first ​

/leech works out of the box because Telegram is already set up. /mirror has nowhere to put the file until you connect Google Drive or Rclone. See Upload Destinations.

What happened? ​

  1. The bot downloaded the file from the internet
  2. It split the file into pieces small enough for Telegram
  3. It sent you the pieces as downloadable files

The bot is working.

What next? ​

You want to...Go here
A one-page list of every commandCheat Sheet
To know what "leech", "seed", "rclone" meanWord List
Save files to Google Drive instead of TelegramSet up a cloud drive
Learn everything the bot can doHow To section
Understand every config settingConfiguration
Deploy on Heroku instead of VPSHeroku guide