🚀 KPS - File To Link Bot ⚡

🚀 High-Performance Telegram File-to-Link Bot ⚡ For Direct Links 🎬 Streaming

</div>

📑 Table of Contents

About The Project
How It Works
Features
Getting Started
- Prerequisites
- Installation
Configuration
- Essential Configuration
- Optional Configuration
Usage and Commands
- Basic Usage
- Commands Reference
Advanced Feature Setup
Production Deployment Guide
- Custom Domain & FQDN System
- Reverse Proxy Setup
Support & Community
- Troubleshooting & FAQ
- Contributing
License
Acknowledgments

<hr>

About The Project

KPS Bots is a powerful Telegram bot that transforms Telegram files into high-speed direct links, perfect for both streaming and rapid downloading. Share files via HTTP(S) links without needing to download them from the Telegram client first.

💡 Perfect For

🚀 Bypassing Telegram's built-in download speed limits
☁️ Unlimited cloud storage with fast streaming and download links
🎬 Content creators sharing media files
👥 Communities distributing resources
🎓 Educational platforms sharing materials

How It Works

User Uploads File → Telegram Bot → Forwards to Channel → Generates Direct Link → Direct Download / Streaming

Upload → User sends any file to the bot.
Store → The bot forwards the file to your private storage channel (BIN_CHANNEL), where it is permanently saved to generate the link.
Generate → A unique, permanent link is created.
Stream/Download → Anyone with the link can stream or download the file directly in their browser.
Balance → Multi-client support distributes the load for high availability.

Features

Core Functionality

✅ Direct Link Generation - Convert any Telegram file into a direct HTTP(S) link.
✅ Permanent Links - Links remain active as long as the file exists in the storage channel.
✅ Browser Streaming & Downloading - Stream media directly or download files at high speed without a Telegram client.
✅ All File Types - Supports video, audio, documents, images, and any other file format.
✅ Batch Processing - Generate links for multiple files at once with a single command.

Performance & Scalability

✅ Multi-Client Support - Distributes traffic across multiple Telegram bots to avoid limits and increase throughput.
✅ Async Architecture - Built with aiohttp and asyncio for non-blocking, high-performance operations.
✅ MongoDB Integration - Ensures persistent and reliable data storage.

Security & Control

🔐 Token Authentication - Secure user access with a time-limited token system.
🛡️ Admin Controls - Full suite of commands for user and bot management.
👤 User Authentication - Require users to join a specific channel before they can use the bot.
✅ Channel/Group Support - Fully functional in private chats, groups, and channels.

Customization

🌍 Custom Domain - Serve files from your own domain for a professional look.
🔗 URL Shortening - Integrate with URL shortener services for clean, shareable links.
🎨 Custom Templates - Personalize messages sent by the bot to match your brand.
📈 Media Info Display - Shows file size, duration, and format details in the response message.

Getting Started

This section covers the system requirements and step-by-step installation guide for setting up KPS Bots.

Prerequisites

Installation

🚀 Deployment Guide (VPS)

1. Installing Requirements

Clone this repository:

git clone https://github.com/Tamilupdates/FileToLink f2l && cd f2l

Setting up config file:

cp config_sample.env config.env

Edit your settings:

nano config.env

Fill up rest of the fields. Meaning of each field is discussed below.

NOTE: All values must be filled between quotes, even if it's Int, Bool or List.

2. Build and Run the Docker Image

Make sure you mount the app folder and install Docker following the official documentation.

There are two methods to build and run the Docker image:

2.1 Using Official Docker Commands

Start Docker daemon (skip if already running):
```
sudo dockerd
```
Build the Docker image:
```
sudo docker build . -t kps
```

Run the image:

sudo docker run --name kps -p 80:80 -p 8080:8080 kps

To stop the running image:

First, list running containers:
```
sudo docker ps
```
Then, stop the container using its ID:
```
sudo docker stop <container_id>
```

2.2 Using docker-compose (Recommended)

Note: If you want to use ports other than 80 and 8080 for torrent file selection and rclone serve respectively, update them in docker-compose.yml.

Install docker-compose:
```
sudo apt install docker-compose
```
Build and run the Docker image (or view the current running image):
```
sudo docker-compose up
```
After editing files (e.g., using nano to edit start.sh), rebuild:
```
sudo docker-compose up --build
```
To stop the running image:
```
sudo docker-compose stop
```
To restart the image:
```
sudo docker-compose start
```
To view the latest logs from the running container (after mounting the folder):
```
sudo docker-compose up
```
Tutorial Video for docker-compose and checking ports:

Docker Notes

IMPORTANT NOTES:

You should stop the running image before deleting the container and you should delete the container before the image.
To delete the container (this will not affect on the image):

sudo docker container prune

To delete te images:

sudo docker image prune -a

<details> <summary><h3>3. Manual Installation</h3></summary>

Clone repository

git clone https://github.com/Tamilupdates/FileToLink f2l
cd f2l

Setup virtual environment

python3 -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

Install dependencies

pip install -r requirements.txt

Configure

cp config_sample.env config.env
nano config.env

Run bot

python -m KPS

Tip: Start with the essential configuration to get KPS running, then add optional features as needed.

</details>

Configuration

Copy config_sample.env to config.env and fill in your values.

Essential Configuration

FileToLink

Install / Use

README