KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #typescript #codex #cli #claude-code #mcp #rust #deepseek-harness #ai-agent

unzip-bot

★ 142 Open GitHub ↗

A Telegram bot deployable to Heroku/VPS that can extract every archive ! With support for split archives, password protected, download from URL, file rename, thumbnail changer, ...

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# unzip-bot
## A Telegram bot to extract various types of archives

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/ruff) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![DeepSource](https://app.deepsource.com/gh/EDM115/unzip-bot.svg/?label=active+issues&show_trend=true&token=17SfwVx77dbrFlixtGdQsQNh)](https://app.deepsource.com/gh/EDM115/unzip-bot/?ref=repository-badge)

[![unzip-bot analytics](https://repobeats.axiom.co/api/embed/5c857b55b42dd8235388093858b74341f6c679ac.svg)](https://github.com/EDM115/unzip-bot/pulse)

</div>

> [!IMPORTANT]  
> The bot is undergoing an important rewrite.  
> Please be patient and wait a few months to get the unzip-bot in its full glory !  
> Check [[ROADMAP] The future of unzip-bot (v7) (#296)](https://github.com/EDM115/unzip-bot/issues/296) to know more about the current development.  
> Check [the master branch](https://github.com/EDM115/unzip-bot/tree/master) to use the older version.

---

## Working bot :smiling_face_with_three_hearts:
[@unzip_edm115bot](https://t.me/unzip_edm115bot)  
More info : [edm115.dev/unzip](https://edm115.dev/unzip)

## Features :eyes:
### User side
- Extract all formats of archives like `rar`, `zip`, `7z`, `tar.gz`, …
- Supports password protected archives
- Able to process split archives (`.001`, `.partX.rar`, …)
- Download files from links
- Rename and set custom thumbnail for files
- Uploads files as documents or media
- Can report issues directly

### Admin side
- Broadcast messages to all users or specific ones
- Ban/unban users from using your bot
- Get realtime stats of the bot usage, along an API
- Ability to set sudo users
- Restart simply the bot and pull updates in one command
- Can eval and exec code directly from Telegram
- Send logs in a custom channel/group + retrieve logs from the bot  
And much more :fire: Dive into the code to find out :hand_over_mouth:

## Config vars :book:
- `APP_ID` - Your APP ID. Get it from [my.telegram.org](https://my.telegram.org)
- `API_HASH` - Your API_HASH. Get it from [my.telegram.org](https://my.telegram.org)
- `BOT_OWNER` - Your Telegram Account ID. Get it from [@MissRose_bot](https://t.me/MissRose_bot) (Start the bot and send `/info` command).
- `BOT_TOKEN` - Bot Token of Your Telegram Bot. Get it from [@BotFather](https://t.me/BotFather)
- `MONGODB_DBNAME` - *(optional)* A custom name for the MongoDB database, useful if you deploy multiple instances of the bot on the same account. Defaults to `Unzipper_Bot`
- `MONGODB_URL` - Your MongoDB URL ([**tutorial here**](CreateMongoDB.md))
- `LOGS_CHANNEL` - Make a private channel and get its ID (search on Google if you don't know how to do). Using a group works as well, just add [`Rose`](https://t.me/MissRose_bot?startgroup=startbot), then send `/id` (In both cases, **make sure to add your bot to the channel/group as an admin !**)

## Commands :writing_hand:
Copy-paste those to BotFather when he asks you for them
```text
commands - Get commands list
mode - Upload as Doc 📄 / Media 📺
addthumb - Add custom thumbnail
delthumb - Remove your thumbnail
stats - Know if bot is overused
clean - Cancel ongoing process
help - In case you need 😭
```

## Deploy :construction:
Deploying is easy :smiling_face_with_three_hearts: You can deploy this bot in Heroku or in a VPS :heart:  
**Star :star2: Fork :fork_and_knife: and Deploy :outbox_tray:**

#### The lazy way
[![Deploy me :pleading_face:](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy?template=https://github.com/EDM115/unzip-bot/tree/v7)  
(if you're in a fork, make sure to replace the template URL with your repo's one, also replace the URL in the Dockerfile)

#### The easy way
- Install [Docker](https://www.docker.com/) then restart your computer (if on Windows)
```bash
git clone https://github.com/EDM115/unzip-bot.git && cd unzip-bot
nano .env
docker build -t edm115/unzip-bot .
```
- Open Docker Desktop, go on the Images tab, click on the Run button
- On Optional settings, fill the env variables

#### The nerdy way
```bash
git clone https://github.com/EDM115/unzip-bot.git && cd unzip-bot
nano .env
docker build -t edm115/unzip-bot .
docker run -d -v downloaded-volume-prod:/app/Downloaded -v thumbnails-volume-prod:/app/Thumbnails --env-file ./.env --name unzipbot edm115/unzip-bot
```

**DONE :partying_face: enjoy the bot !** Be sure to follow me on [GitHub](https://github.com/EDM115) and Star :star2: this repo to show some support :pleading_face:

## How to build after changes ?
#### Trust GitHub Actions
- Add new Actions secrets to the repo :
  - `DOCKER_USERNAME` : all in lowercase
  - `DOCKER_TOKEN` : one with all rights, here : https://hub.docker.com/settings/security
- Go in Actions tab, 2 workflows are here for ya :
  - `Build Docker Image` : Check if it builds without errors
  - `Publish Docker Image` : Rebuild && publish

#### Do it manually
- Go in the repo's folder
```bash
docker build --no-cache -t edm115/unzip-bot .
docker run -d -v downloaded-volume:/app/Downloaded -v thumbnails-volume:/app/Thumbnails --env-file ./.env --network host --name unzip-bot-container edm115/unzip-bot
docker start unzip-bot-container
# if you want to check something
docker exec -it unzip-bot-container sh
docker logs unzip-bot-container
# once you're done
docker stop unzip-bot-container
```
- If you wanna publish :
```bash
docker tag edm115/unzip-bot edm115/unzip-bot:latest
```
*(replace `edm115` with your docker hub username, `unzip-bot` with the repo's name and `latest` whith whatever you want)*
```bash
docker login
```
*login and don't mind the errors*
```bash
docker push edm115/unzip-bot:latest
```
*(same, replace accordingly)*

## Found a bug :bug:
If you found a bug in this bot please open an [issue](https://github.com/EDM115/unzip-bot/issues) or report it on Telegram : [@EDM115](https://t.me/EDM115)  
Same if you have any feature request :wink:

## License & Copyright :cop:
Copyright (c) 2022 - 2025 EDM115  
  
This unzip-bot repository is licensed under the [MIT License](https://github.com/EDM115/unzip-bot/blob/master/LICENSE)  
Enjoy copying and modifying, but always mention me  
  
• Inspired by Itz-fork/Nexa's work, but with additional features and bug fixes.  
This is a maintained repo of the [original](https://github.com/Itz-fork/Unzipper-Bot), props to him for the OG code

unzip-bot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README