diff --git a/README.md b/README.md index 50e3c33..e7f7d50 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -

Telegram File to Link Bot !

+

FileStreamBot

Cover Image

- A Telegram bot to stream files to web. + A Telegram bot to all media and documents files to web link .

@@ -19,7 +19,7 @@ -## About This Bot +## 🍁 About This Bot :

@@ -31,24 +31,34 @@

-## How to make your own +## ♢ How to make your own : Either you could locally host or deploy on [Heroku](https://heroku.com) -### Deploy on Heroku +
+ +#### ♢ Click on This Drop-down and get more details + +
+
+ Deploy on Heroku : + 1. Fork This Repo 2. Click on Deploy Easily -### So Follow Above Steps 👆 and then also deply other wise not work +

So Follow Above Steps 👆 and then also deply other wise not work

Press the below button to Fast deploy on Heroku [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) -then goto the
variables tab for more info on setting up environmental variables. +then goto the variables tab for more info on setting up environmental variables.
+ + +
+ Host it on VPS Locally : -### Host it on VPS or Locally ```py git clone https://github.com/avipatilpro/FileStreamBot @@ -62,7 +72,7 @@ python3 -m WebStreamer and to stop the whole bot, do CTRL+C -## Setting up things +Setting up things If you're on Heroku, just add these in the Environmental Variables or if you're Locally hosting, create a file named `.env` in the root directory and add all the variables there. @@ -78,8 +88,10 @@ FQDN=your_server_ip OWNER_ID=your_user_id DATABASE_URL=mongodb_uri ``` +
-### Mandatory Vars +
+ Vars and Details : `API_ID` : Goto [my.telegram.org](https://my.telegram.org) to obtain this. @@ -93,7 +105,7 @@ DATABASE_URL=mongodb_uri `DATABASE_URL` : MongoDB URI for saving User IDs when they first Start the Bot. We will use that for Broadcasting to them. I will try to add more features related with Database. If you need help to get the URI you can ask in [Me Telegram](https://t.me/Avishkarpatil). -### Optional Vars + Option Vars `UPDATES_CHANNEL` : Put a Public Channel Username, so every user have to Join that channel to use the bot. Must add bot to channel as Admin to work properly. @@ -109,9 +121,10 @@ DATABASE_URL=mongodb_uri `NO_PORT` : If you don't want your port to be displayed. You should point your `PORT` to `80` (http) or `443` (https) for the links to work. Ignore this if you're on Heroku. -`FQDN` : A Fully Qualified Domain Name if present. Defaults to `WEB_SERVER_BIND_ADDRESS` +`FQDN` : A Fully Qualified Domain Name if present. Defaults to `WEB_SERVER_BIND_ADDRESS`
-## How to use the bot +
+ How to Use : :warning: **Before using the bot, don't forget to add the bot to the `BIN_CHANNEL` as an Admin** @@ -120,11 +133,11 @@ DATABASE_URL=mongodb_uri To get an instant stream link, just forward any media to the bot and boom, its fast af. ### Channel Support -Bot also Supported with Channels. Just add bot Channel as Admin. If any new file comes in Channel it will edit it with **Get Download Link** Button. +Bot also Supported with Channels. Just add bot Channel as Admin. If any new file comes in Channel it will edit it with **Get Download Link** Button.
-## Credits +### 😈 Thanks to : -- [@Avishkarpatil](https://telegram.me/Avishkarpatil) - -- [@EverythingSuckz](https://github.com/EverythingSuckz) +- [Avishkarpatil](https://telegram.me/Avishkarpatil) +- [EverythingSuckz](https://github.com/EverythingSuckz) +- Everyone In This Journey !