teldrive/README.md
2023-08-17 18:18:15 +05:30

5 KiB

Fast Telegram Drive

Table of Contents
  1. How to make your own
  2. Setting up things

Demo

demo

UI Repo

Deploy using docker-compose

First clone the repository

git clone https://github.com/divyam234/teldrive
cd teldrive

Follow Below Steps

  • Create the .env file with your variables and start your container.
  • If you are deploying without https replace nginx.conf with nginx_nossl.conf in docker-compose.yml.
  • Also Replace #DBURL with POSTGRES URL to RUN first time migrations and add ?search_path=public to postgres url at end so that migrations don't error out.

It should look like this below if you are not using https.

volumes:
      - ./nginx_nossl.conf:/etc/nginx/conf.d/default.conf
ports:
    - 8000:8000
docker compose up -d

Deploy without docker-compose

First clone the repository

git clone https://github.com/divyam234/teldrive

Follow Below Steps

  • Fork UI Repo given above and Deploy it to Vercel.
  • Download release binary of teldrive from releases section.
  • .env file will be same as mentioned above..
  • You have to run migrations manually for first run for that you have to download altasgo from here.
atlas migrate apply \
  --url postgres://root:pass@:5432/db1?search_path=public \
  --dir file://database/migrations --allow-dirty
  • Now run the teldrive executable from releases.

  • Finally change API URL from UI deployed on vercel to http://localhost:8080 in settings.

Setting up things

If you're locally or remotely hosting, create a file named .env in the root directory and add all the variables there. An example of .env file:

API_ID=1234
API_HASH=abc
CHANNEL_ID=1234
JWT_SECRET=abc
DATABASE_URL=abc
MULTI_CLIENT=true # true or false here
MULTI_TOKEN1=55838383:yourfirstmulticlientbottokenhere
MULTI_TOKEN2=55838383:yoursecondmulticlientbottokenhere
MULTI_TOKEN3=55838383:yourthirdmulticlientbottokenhere

Multi Client Mode is recommended way to avoid flood errors and to enable max download speed if you are using downloaders like IDM and aria2c which use multiple connections to download files.

Mandatory Vars

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.

  • JWT_SECRET : Used for signing jwt tokens

  • DATABASE_URL : Connection String obtained from Postgres DB (you can use Neon db as free alternative fro postgres)

  • CHANNEL_ID : This is the channel ID for the log channel where app will store files . 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.

Optional Vars

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

  • MULTI_CLIENT : Enable or Disable Multi Token mode. If true you have pass atleast one Multi Token
  • MULTI_TOKEN[1....] : Recommended to add atleast 10-12 tokens

For making use of Multi-Client support

Note

What it multi-client feature and what it does?
This feature shares the Telegram API requests between other bots to avoid getting floodwaited (A kind of rate limiting that Telegram does in the backend to avoid flooding their servers) and to make the server handle more requests.

To enable multi-client, generate new bot tokens and add it as your environmental variables 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 not tested yet) MULTI_TOKEN3, MULTI_TOKEN4, etc.

Warning

Don't forget to add all these bots to the CHANNEL_ID as admin for the proper functioning

FAQ

  • How to get Postgres DB url ?

You can spin up local postgres instance but its not recommended as there is lot of hassle in backup and transfering data.Recommended way is to use any free cloud postgres DB.I will recommend to use Neon DB.

Contributing

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