TG-FileStreamBot-Api

A Telegram bot to generate direct link for your Telegram files with HTTP Upload API support

Press the below button to fast deploy to Heroku

Click Here to know how to add / edit environment variables in Heroku.

• Head over to releases tab, from the pre release section, download the one for your platform and architecture.
• Extract the zip file to a folder.
• Create an a file named fsb.env and add all the variables there (see fsb.sample.env file for reference).
• Give the executable file permission to execute using the command chmod +x fsb (Not required for windows).
• Run the bot using ./fsb run command. ( ./fsb.exe run for windows)

• Clone the repository

git clone https://github.com/EverythingSuckz/TG-FileStreamBot-Api
cd TG-FileStreamBot-Api

• Create an a file named fsb.env and add all the variables there (see fsb.sample.env file for reference).

nano fsb.env

• Build and run the docker-compose file

docker-compose up -d

OR

docker compose up -d

docker run --env-file fsb.env ghcr.io/everythingsuckz/fsb:latest

Where fsb.env is the environment file containing all the variables.

git clone https://github.com/EverythingSuckz/TG-FileStreamBot-Api
cd TG-FileStreamBot-Api
go build ./cmd/fsb/
chmod +x fsb
mv fsb.sample.env fsb.env
nano fsb.env
# (add your environment variables, see the next section for more info)
./fsb run

and to stop the program, do CTRL+C

git clone https://github.com/EverythingSuckz/TG-FileStreamBot-Api
cd TG-FileStreamBot-Api
go build ./cmd/fsb/
Rename-Item -LiteralPath ".\fsb.sample.env" -NewName ".\fsb.env"
notepad fsb.env
# (add your environment variables, see the next section for more info)
.\fsb run

and to stop the program, do CTRL+C

If you're locally hosting, create a file named fsb.env in the root directory and add all the variables there. You may check the fsb.sample.env. An example of fsb.env file:

API_ID=452525
API_HASH=esx576f8738x883f3sfzx83
BOT_TOKEN=55838383:yourbottokenhere
LOG_CHANNEL=-10045145224562
PORT=8080
HOST=http://yourserverip
# (if you want to set up multiple bots)
MULTI_TOKEN1=55838373:yourworkerbottokenhere
MULTI_TOKEN2=55838355:yourworkerbottokenhere

Before running the bot, you will need to set up the following mandatory variables:

• API_ID : This is the API ID for your Telegram account, which can be obtained from my.telegram.org.

• API_HASH : This is the API hash for your Telegram account, which can also be obtained from my.telegram.org.

• BOT_TOKEN : This is the bot token for the Telegram Media Streamer Bot, which can be obtained from @BotFather.

• LOG_CHANNEL : This is the channel ID for the log channel where the bot will forward media messages and store these files to make the generated direct links work. To obtain a channel ID, create a new telegram channel (public or private), post something in the channel, forward the message to @missrose_bot and reply the forwarded message with the /id command. Copy the forwarded channel ID and paste it into the this field.

In addition to the mandatory variables, you can also set the following optional variables:

• PORT : This sets the port that your webapp will listen to. The default value is 8080.

• HOST : A Fully Qualified Domain Name if present or use your server IP. (eg. https://example.com or http://14.1.154.2:8080)

• HASH_LENGTH : Custom hash length for generated URLs. The hash length must be greater than 5 and less than or equal to 32. The default value is 6.

• USE_SESSION_FILE : Use session files for worker client(s). This speeds up the worker bot startups. (default: false)

• USER_SESSION : A pyrogram session string for a user bot. Used for auto adding the bots to LOG_CHANNEL. (default: null)

• ALLOWED_USERS : A list of user IDs separated by comma (,). If this is set, only the users in this list will be able to use the bot. (default: null)

[!NOTE] > What it multi-client feature and what it does?
This feature shares the Telegram API requests between worker bots to speed up download speed when many users are using the server and to avoid the flood limits that are set by Telegram.

To enable multi-client, generate new bot tokens and add it as your fsb.env with the following key names.

MULTI_TOKEN1: Add your first bot token here.

MULTI_TOKEN2: Add your second bot token here.

you may also add as many as bots you want. (max limit is 50) MULTI_TOKEN3, MULTI_TOKEN4, etc.

To use this feature, you need to generate a pyrogram session string for the user account and add it to the USER_SESSION variable in the fsb.env file.

This feature is used to auto add the worker bots to the LOG_CHANNEL when they are started. This is useful when you have a lot of worker bots and you don't want to add them manually to the LOG_CHANNEL.

The easiest way to generate a session string is by running

./fsb session --api-id <your api id> --api-hash <your api hash>

This will generate a session string for your user account using QR code authentication. Authentication via phone number is not supported yet and will be added in the future.

TG-FileStreamBot-Api now supports HTTP file upload functionality, allowing you to upload files via RESTful API and automatically generate streaming download links.

POST /upload
Content-Type: multipart/form-data
Authorization: Bearer YOUR_UPLOAD_TOKEN

Request Parameters:

• file: The file to upload (required)

Response:

{
  "success": true,
  "message": "Upload successful",
  "data": {
    "filename": "document.pdf",
    "size": 1048576,
    "mimeType": "application/pdf",
    "messageId": 12345,
    "streamUrl": "http://your-domain.com/stream/12345?hash=abc123",
    "downloadUrl": "http://your-domain.com/stream/12345?hash=abc123&d=true",
    "hash": "abc123",
    "uploadTime": "2024-01-01T12:00:00Z"
  }
}

POST /upload/batch
Content-Type: multipart/form-data
Authorization: Bearer YOUR_UPLOAD_TOKEN

Request Parameters:

• files: Multiple files to upload (max 10 files)

Response:

{
  "success": true,
  "message": "Batch upload completed",
  "summary": {
    "totalFiles": 3,
    "successCount": 2,
    "failedCount": 1,
    "totalSize": 2097152
  },
  "results": [
    {
      "filename": "file1.jpg",
      "success": true,
      "data": {
        /* same as single file upload */
      }
    },
    {
      "filename": "file2.exe",
      "success": false,
      "error": "File extension not allowed"
    }
  ]
}

GET /upload/status
Authorization: Bearer YOUR_UPLOAD_TOKEN

Response:

{
  "userId": "user123",
  "usedQuota": 104857600,
  "maxQuota": 10737418240,
  "quotaPercent": 0.98,
  "remaining": 18857640
}

GET /upload/metrics
Authorization: Bearer YOUR_UPLOAD_TOKEN

Response:

{
  "metrics": {
    "totalUploads": 1500,
    "totalSize": 1073741824,
    "failedUploads": 12,
    "blockedUploads": 8,
    "activeUsers": 25,
    "averageSize": 715827.88
  }
}

Add the following configuration to your fsb.env file:

# Enable Upload API
ENABLE_UPLOAD_API=true

# Authentication Token
UPLOAD_AUTH_TOKEN=your-secret-upload-token-here

# File Limitations
MAX_FILE_SIZE=2147483648                    # 2GB
USER_QUOTA=10737418240                      # 10GB per user

# Allowed File Types
ALLOWED_MIME_TYPES=image/jpeg,image/png,video/mp4,application/pdf,text/plain
ALLOWED_EXTENSIONS=.jpg,.jpeg,.png,.mp4,.pdf,.txt

# Rate Limiting
UPLOADS_PER_MINUTE=5
UPLOADS_PER_HOUR=50
CONCURRENT_UPLOADS_PER_USER=3
API_COOLDOWN_SECONDS=1

# Security Settings
ENABLE_PROTECTION_MODE=true
ENABLE_DEEP_SCAN=false

Single File Upload:

curl -X POST http://your-domain.com/upload \
  -H "Authorization: Bearer your-secret-upload-token-here" \
  -F "file=@/path/to/your/file.pdf"

Batch Upload:

curl -X POST http://your-domain.com/upload/batch \
  -H "Authorization: Bearer your-secret-upload-token-here" \
  -F "files=@/path/to/file1.jpg" \
  -F "files=@/path/to/file2.mp4" \
  -F "files=@/path/to/file3.txt"

Query Status:

curl -X GET http://your-domain.com/upload/status \
  -H "Authorization: Bearer your-secret-upload-token-here"

import requests

BASE_URL = "http://your-domain.com"
AUTH_TOKEN = "your-secret-upload-token-here"

def upload_file(file_path):
    """Upload a single file"""
    url = f"{BASE_URL}/upload"
    headers = {"Authorization": f"Bearer {AUTH_TOKEN}"}

    with open(file_path, 'rb') as f:
        files = {'file': f}
        response = requests.post(url, files=files, headers=headers)

    return response.json()

# Upload a file
result = upload_file("/path/to/document.pdf")
print(result)

async function uploadFile(file) {
  const formData = new FormData()
  formData.append('file', file)

  const response = await fetch('http://your-domain.com/upload', {
    method: 'POST',
    headers: {
      Authorization: 'Bearer your-secret-upload-token-here',
    },
    body: formData,
  })

  return await response.json()
}

// Usage
const fileInput = document.getElementById('fileInput')
const file = fileInput.files[0]
const result = await uploadFile(file)
console.log(result)

All upload requests must include a valid Authorization: Bearer YOUR_TOKEN header.

• Type Checking: Validates MIME type and file extension
• Size Checking: Limits single file to maximum 2GB (configurable)
• Content Validation: Checks file header authenticity (optional deep scan)
• Quota Checking: Limits total storage usage per user

• Per-Minute Limit: Default 5 files/minute/user
• Per-Hour Limit: Default 50 files/hour/user
• Concurrent Limit: Default 3 simultaneous uploads/user
• API Cooldown: Default 1 second cooldown between uploads

Feel free to contribute to this project if you have any further ideas

You can contact either via my Telegram Group or you can message me on @EverythingSuckz

• @celestix for gotgproto
• @divyam234 for his Teldrive Project
• @karu for adding image support

Copyright (C) 2023 EverythingSuckz under GNU Affero General Public License.

TG-FileStreamBot is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Also keep in mind that all the forks of this repository MUST BE OPEN-SOURCE and MUST BE UNDER THE SAME LICENSE.