mirror of
https://github.com/TheCaduceus/FileStreamBot.git
synced 2026-01-15 16:33:25 -03:00
116 lines
3.6 KiB
Markdown
116 lines
3.6 KiB
Markdown
<div align="center"><h1>🌐File Stream Bot</h1>
|
|
<b>An open-source Python Telegram bot to transmit Telegram files over HTTP.</b>
|
|
|
|
<a href="https://t.me/DrFileStreamBot"><b>Demo Bot</b></a>
|
|
</div><br>
|
|
|
|
## **📑 INDEX**
|
|
|
|
* [**⚙️ Installation**](#installation)
|
|
* [Python & Git](#i-1)
|
|
* [Download](#i-2)
|
|
* [Requirements](#i-3)
|
|
* [**📝 Variables**](#variables)
|
|
* [**🕹 Deployment**](#deployment)
|
|
* [Locally](#d-1)
|
|
* [Docker](#d-2)
|
|
* [**⛑️ Need help!**](#help)
|
|
* [**❤️ Credits & Thanks**](#credits)
|
|
|
|
<a name="installation"></a>
|
|
|
|
## ⚙️ Installation
|
|
|
|
<a name="i-1"></a>
|
|
|
|
**1.Install Python & Git:**
|
|
|
|
For Windows:
|
|
```
|
|
winget install Python.Python.3.11
|
|
winget install Git.Git
|
|
```
|
|
For Linux:
|
|
```
|
|
sudo apt-get update && sudo apt-get install -y python3.11 git pip
|
|
```
|
|
For macOS:
|
|
```
|
|
brew install python@3.11 git
|
|
```
|
|
For Termux:
|
|
```
|
|
pkg install python -y
|
|
pkg install git -y
|
|
```
|
|
|
|
<a name="i-2"></a>
|
|
|
|
**2.Download repository:**
|
|
```
|
|
git clone https://github.com/TheCaduceus/FileStreamBot.git
|
|
```
|
|
|
|
**3.Change Directory:**
|
|
|
|
```
|
|
cd FileStreamBot
|
|
```
|
|
|
|
<a name="i-3"></a>
|
|
|
|
**4.Install requirements:**
|
|
|
|
```
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
<a name="variables"></a>
|
|
|
|
## 📝 Variables
|
|
**The variables provided below should either be completed within the [config.py](https://github.com/TheCaduceus/FileStreamBot/blob/main/bot/config.py) file or configured as environment variables.**
|
|
* `API_ID`|`TELEGRAM_API_ID`: API ID of your Telegram account, can be obtained from [My Telegram](https://my.telegram.org). `int`
|
|
* `API_HASH`|`TELEGRAM_API_HASH`: API hash of your Telegram account, can be obtained from [My Telegram](https://my.telegram.org). `str`
|
|
* `OWNER_ID`: ID of your Telegram account, can be obtained by sending **/info** to [@DrFileStreamBot](https://t.me/DrFileStreamBot). `int`
|
|
* `ALLOWED_USER_IDS`: A list of Telegram account IDs (separated by spaces) that are permitted to use the bot. Leave this field empty to allow anyone to use it. `str`
|
|
* `BOT_USERNAME`|`TELEGRAM_BOT_USERNAME`: Username of your Telegram bot, create one using [@BotFather](https://t.me/BotFather). `str`
|
|
* `BOT_TOKEN`|`TELEGRAM_BOT_TOKEN`: Telegram API token of your bot, can be obtained from [@BotFather](https://t.me/BotFather). `str`
|
|
* `CHANNEL_ID`|`TELEGRAM_CHANNEL_ID`: ID of the channel where bot will forward all files received from users, can be obtained by forwarding any message from channel to [@ShowJsonBot](https://t.me/ShowJsonBot) and then looking from `forward_from_chat` key. `int`
|
|
* `BOT_WORKERS`: Number of updates bot should process from Telegram at once, by default to 10 updates. `int`
|
|
* `SECRET_CODE_LENGTH`: Number of characters that file code should contain, by default to 12 characters. `int`
|
|
* `BASE_URL`: Base URL that bot should use while generating file links, can be FQDN and by default to `127.0.0.1`. `str`
|
|
* `BIND_ADDRESS`: Bind address for web server, by default to `0.0.0.0` to run on all possible addresses. `str`
|
|
* `PORT`: Port for web server to run on, by default to `8080`. `int`
|
|
|
|
## 🕹 Deployment
|
|
|
|
<a name="d-1"></a>
|
|
|
|
**1.Running locally:**
|
|
```
|
|
python -m bot
|
|
```
|
|
|
|
<a name="d-2"></a>
|
|
|
|
**2.Using Docker:** *(Recommended)*
|
|
* Build own Docker image:
|
|
```
|
|
docker build -t file-stream-bot .
|
|
```
|
|
* Run the Docker container:
|
|
```
|
|
docker run -p 8080:8080 file-stream-bot
|
|
```
|
|
|
|
<a name="help"></a>
|
|
|
|
## ⛑️ Need help!
|
|
- Ask questions or doubts [here](https://t.me/DrDiscussion).
|
|
|
|
<a name="credits"></a>
|
|
|
|
## ❤️ Credits & Thanks
|
|
|
|
[**Dr.Caduceus**](https://github.com/TheCaduceus): Owner & developer of File Stream Bot.
|