Telegram File Stream Bot

Installation ​

FSB is written in Go, which means it compiles down to a single binary. You can run it practically anywhere. Here is how to get it running on your machine.

🟢 NOTE

This guide is for locally running the bot on your own computer. If you want to host it on a cloud server, check out the Deployment Options guide.

Prerequisites ​

Make sure you have completed the Prerequisites guide. You should have your API_ID, API_HASH, BOT_TOKEN, and LOG_CHANNEL variables ready.

Install Script ​

Option 1 (Recommended): The easiest way to install FSB is via our installation script which automatically sets up the latest binary for your system:

Run the installation script ​
  1. Run the following command in your terminal:
bash
curl -sL https://filestream.bot/install | bash
txt
Please download the binary manually from the releases page.

🟢 NOTE

When running the above command, it'll ask for some questions. If you don't understand any of them, just press Enter to select the default value.

🟠 WARNING

This script only works on Linux and macOS. You'll have to download the binary manually if you're on Windows from the releases page.

Configure the env file ​
  1. After running the script, goto the fsb.env file that was created (if it was not created, create it yourself) and fill in your credentials.

Here is here's how fsb.env file looks like:

bash
API_ID=452525
API_HASH=esx576f8738x883f3sfzx83
BOT_TOKEN=55838383:yourbottokenhere
LOG_CHANNEL=-10045145224562
Run the bot ​
  1. Run the bot using the following command:
bash
cd FSB/
./fsb run
ps1
.\fsb.exe run

🟢 NOTE

This command can vary based on where you downloaded the binary and how you named it. Just make sure to navigate to the directory where the fsb binary is located and run it with the run argument.

Binary Releases ​

Option 2: If you prefer to download it manually:

  1. Head over to the releases page on GitHub.
  2. Download the appropriate binary for your system (Linux, macOS, or Windows).
  3. Extract the file.
  4. Rename fsb.sample.env to fsb.env and fill in your credentials.
  5. Run the bot using the following command:
bash
cd FSB/
./fsb run
ps1
.\fsb.exe run

🟢 NOTE

This command can vary based on where you downloaded the binary and how you named it. Just make sure to navigate to the directory where the fsb binary is located and run it with the run argument.

Docker ​

Option 3: Docker is also fully supported if you prefer containerized environments. First, save your configuration into a file named fsb.env (we will cover other settings in the Configuration section):

Here is here's how fsb.env file looks like:

bash
API_ID=452525
API_HASH=esx576f8738x883f3sfzx83
BOT_TOKEN=55838383:yourbottokenhere
LOG_CHANNEL=-10045145224562

Then, run the container:

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

Docker Compose ​

If you prefer docker-compose.yaml:

yaml
Loading...

Bring it up with:

bash
docker-compose up -d

🟢 NOTE

Run this command in the same directory where your docker-compose.yaml and fsb.env files are located.

Building from Source ​

If you want to compile the bot yourself, you will need Go 1.25 or higher installed on your system.

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

# Build the binary
go build ./cmd/fsb/

# Set up your environment file
cp fsb.sample.env fsb.env

Fill in your credentials in fsb.env, see Configuration for details on each variable.

Then run the bot:

bash
cd FSB/
./fsb run
ps1
.\fsb.exe run

🟢 NOTE

This command can vary based on where you downloaded the binary and how you named it. Just make sure to navigate to the directory where the fsb binary is located and run it with the run argument.

Next Steps ​

If you want to host the bot on a cloud platform instead of your own machine, check out the Deployment Options. Otherwise, head over to the Configuration section to learn how to properly configure your bot.