SparkXcloud-Gdrive-MirrorBot is a multipurpose Telegram Bot writen in Python for mirroring files on the Internet to our beloved Google Drive.
BOT_TOKEN
: The Telegram Bot Token that you got from @BotFatherGDRIVE_FOLDER_ID
: This is the Folder/TeamDrive ID of the Google Drive Folder to which you want to upload all the mirrors.OWNER_ID
: The Telegram User ID (not username) of the Owner of the bot.Int
DOWNLOAD_DIR
: The path to the local folder where the downloads should be downloaded to.DOWNLOAD_STATUS_UPDATE_INTERVAL
: Time in seconds after which the progress/status message will be updated. Recommended10
seconds at least.Int
AUTO_DELETE_MESSAGE_DURATION
: Interval of time (in seconds), after which the bot deletes it's message and command message which is expected to be viewed instantly. NOTE: Set to-1
to disable auto message deletion.Int
IS_TEAM_DRIVE
: SetTrue
if uploading to TeamDrive. Default isFalse
.Bool
TELEGRAM_API
: This is to authenticate your Telegram account for downloading Telegram files. You can get this from https://my.telegram.org.Int
TELEGRAM_HASH
: This is to authenticate your Telegram account for downloading Telegram files. You can get this from https://my.telegram.org.
DATABASE_URL
: Your SQL Database URL. Follow this Generate Database to generate database. Data will be saved in Database: auth and sudo users, leech settings including thumbnails for each user, rss data and incomplete tasks. NOTE: If deploying on heroku and using heroku postgresql delete this variable from config.env file. DATABASE_URL will be grabbed from heroku variables.AUTHORIZED_CHATS
: Fill user_id and chat_id of groups/users you want to authorize. Separate them by space.SUDO_USERS
: Fill user_id of users whom you want to give sudo permission. Separate them by space.IGNORE_PENDING_REQUESTS
: Ignore pending requests after restart. Default isFalse
.Bool
USE_SERVICE_ACCOUNTS
: Whether to use Service Accounts or not. For this to work see Using Service Accounts section. Default isFalse
.Bool
INDEX_URL
: Refer to https://gitlab.com/ParveenBhadooOfficial/Google-Drive-Index.STATUS_LIMIT
: Limit the no. of tasks shown in status message with buttons. NOTE: Recommended limit is4
tasks.STOP_DUPLICATE
: Bot will check file in Drive, if it is present in Drive, downloading or cloning will be stopped. (NOTE: File will be checked using filename not file hash, so this feature is not perfect yet). Default isFalse
.Bool
CMD_INDEX
: commands index number. This number will added at the end all commands.UPTOBOX_TOKEN
: Uptobox token to mirror uptobox links. Get it from Uptobox Premium Account.TORRENT_TIMEOUT
: Timeout of dead torrents downloading with qBittorrent and Aria2c in seconds.EXTENTION_FILTER
: File extentions that won't upload/clone. Separate them by space.INCOMPLETE_TASK_NOTIFIER
: Get incomplete task messages after restart. Require database and (supergroup or channel). Default isFalse
.Bool
UPSTREAM_REPO
: Your github repository link, if your repo is private addhttps://username:{githubtoken}@github.com/{username}/{reponame}
format. Get token from Github settings. So you can update your bot from filled repository on each restart. NOTE: Any change in docker or requirements you need to deploy/build again with updated repo to take effect. DON'T delete .gitignore file.UPSTREAM_BRANCH
: Upstream branch for update. Default ismaster
.
TG_SPLIT_SIZE
: Size of split in bytes. Default is2GB
.AS_DOCUMENT
: Default type of Telegram file upload. Default isFalse
mean as media.Bool
EQUAL_SPLITS
: Split files larger than TG_SPLIT_SIZE into equal parts size (Not working with zip cmd). Default isFalse
.Bool
CUSTOM_FILENAME
: Add custom word to leeched file name.
BASE_URL_OF_BOT
: Valid BASE URL where the bot is deployed to use qbittorrent web selection. Format of URL should behttp://myip
, wheremyip
is the IP/Domain(public) of your bot or if you have chosen port other than80
so write it in this formathttp://myip:port
(http
and nothttps
). This Var is optional on VPS and required for Heroku specially to avoid app sleeping/idling. For Heroku fillhttps://yourappname.herokuapp.com
. Still got idling? You can use http://cron-job.org to ping your Heroku app.SERVER_PORT
: Only For VPS even ifIS_VPS
isFalse
, which is the BASE_URL_OF_BOT Port.WEB_PINCODE
: If empty orFalse
means no more pincode required while qbit web selection.Bool
QB_SEED
: QB torrent will be seeded after and while uploading until reaching specific ratio or time, editMaxRatio
orGlobalMaxSeedingMinutes
or both from qbittorrent.conf (-1
means no limit, but u can cancel manually by gid). NOTE: 1. Don't changeMaxRatioAction
, 2. Only works with/qbmirror
and/qbzipmirror
. Default isFalse
.Bool
- Qbittorrent NOTE: If your facing ram exceeded issue then set limit for
MaxConnecs
and decreaseAsyncIOThreadsCount
in qbittorrent config.
- Qbittorrent NOTE: If your facing ram exceeded issue then set limit for
RSS_DELAY
: Time in seconds for rss refresh interval. Recommended900
second at least. Default is900
in sec.RSS_COMMAND
: Choose command for the desired action.RSS_CHAT_ID
: Chat ID where rss links will be sent. If using channel then add channel id.USER_SESSION_STRING
: To send rss links from your telegram account instead of adding bot to channel then linking the channel to group to get rss link since bot will not read command from itself or other bot. To generate session string use this commandpython3 generate_string_session.py
after mounting repo folder for sure.- RSS NOTE:
DATABASE_URL
andRSS_CHAT_ID
is required, otherwise all rss commands will not work. Add the bot in grop for better experience, since if you are usingUSER_STRING_SESSION
you need to send a private message to bot after each restart. You can add the bot to a channel and add this channel to group so messages sent by bot to channel will be forwarded to group without usingUSER_STRING_SESSION
.
- RSS NOTE:
ACCOUNTS_ZIP_URL
: Only if you want to load your Service Account externally from an Index Link or by any direct download link NOT webpage link. Archive the accounts folder to ZIP file. Fill this with the direct download link of zip file. If index need authentication so add direct download as shown below:https://username:[email protected]/...
TOKEN_PICKLE_URL
: Only if you want to load your token.pickle externally from an Index Link. Fill this with the direct link of that file.MULTI_SEARCH_URL
: Checkdrive_folder
setup. Write drive_folder file here. Open the raw file of that gist, it's URL will be your required variable. Should be in this form after removing commit id: https://gist.githubusercontent.com/username/gist-id/raw/drive_folderYT_COOKIES_URL
: Youtube authentication cookies. Check setup Here. Use gist raw link and remove commit id from the link, so you can edit it from gists only.NETRC_URL
: To create .netrc file contains authentication for aria2c and yt-dlp. Use gist raw link and remove commit id from the link, so you can edit it from gists only. NOTE: After editing .nterc you need to restart the docker or if deployed on heroku so restart dyno in case your edits related to aria2c authentication.- NOTE: All above url variables used incase you want edit them in future easily without deploying again or if you want to deploy from public fork. If deploying using cli or private fork you can leave these variables empty add token.pickle, accounts folder, drive_folder, .netrc and cookies.txt directly to root but you can't update them without rebuild OR simply leave all above variables and use private UPSTREAM_REPO.
MEGA_API_KEY
: Mega.nz API key to mirror mega.nz links. Get it from Mega SDK PageMEGA_EMAIL_ID
: E-Mail ID used to sign up on mega.nz for using premium account.MEGA_PASSWORD
: Password for mega.nz account.
SHORTENER_API
: Fill your Shortener API key.SHORTENER
: Shortener URL.- Supported URL Shorteners:
exe.io, gplinks.in, shrinkme.io, urlshortx.com, shortzon.com, bit.ly, shorte.st, linkvertise.com , ouo.io, adfoc.us, cutt.ly
CRYPT
: Cookie for gdtot google drive link generator. Follow these steps.
TORRENT_DIRECT_LIMIT
: To limit the Torrent/Direct mirror size. Don't add unit. Default unit isGB
.ZIP_UNZIP_LIMIT
: To limit the size of zip and unzip commands. Don't add unit. Default unit isGB
.CLONE_LIMIT
: To limit the size of Google Drive folder/file which you can clone. Don't add unit. Default unit isGB
.MEGA_LIMIT
: To limit the size of Mega download. Don't add unit. Default unit isGB
.STORAGE_THRESHOLD
: To leave specific storage free and any download will lead to leave free storage less than this value will be cancelled. Don't add unit. Default unit isGB
.
-
VIEW_LINK
: View Link button to open file Index Link in browser instead of direct download link, you can figure out if it's compatible with your Index code or not, open any video from you Index and check if its URL ends with?a=view
, if yes make itTrue
, compatible with BhadooIndex Code. Default isFalse
.Bool
-
Three buttons are already added including Drive Link, Index Link, and View Link, you can add extra buttons, if you don't know what are the below entries, simply leave them empty.
BUTTON_FOUR_NAME
:BUTTON_FOUR_URL
:BUTTON_FIVE_NAME
:BUTTON_FIVE_URL
:BUTTON_SIX_NAME
:BUTTON_SIX_URL
:
SEARCH_API_LINK
: Search api app link. Get your api from deploying this repository.- Supported Sites:
1337x, Piratebay, Nyaasi, Torlock, Torrent Galaxy, Zooqle, Kickass, Bitsearch, MagnetDL, Libgen, YTS, Limetorrent, TorrentFunk, Glodls, TorrentProject and YourBittorrent
SEARCH_LIMIT
: Search limit for search api, limit for each site and not overall result limit. Default is zero (Default api limit for each site).SEARCH_PLUGINS
: List of qBittorrent search plugins (github raw links). I have added some plugins, you can remove/add plugins as you want. Main Source: qBittorrent Search Plugins (Official/Unofficial).
-
All commands can also be called using dot(.) instead of slash(/). For e.x:
.mirror <url>
or.m <url>
-
All commands except
list
can have the bot's username appended to them. SeeCOMMANDS_USE_BOT_NAME
under constants description. This is useful if you have multiple instances of this bot in the same group. -
While creating a Telegram bot in the pre-installation section below, you might want to add the above commands to your new bot by using
/setcommand
in BotFather, make sure all the commands are in lower case. This will cause a list of available bot commands to pop up in chats when you type/
, and you can long press one of them to select it instead of typing out the entire command.
Click Here For More Details
- qBittorrent supported
- Updater (NOTE: You must upload your token.pickle to Index and fill your token.pickle url to TOKEN_PICKLE_URL, because your token.pickle will deleted after update, for more info please check Setting up config file)
- Limiting size Torrent/Direct, Tar/Unzip, Mega, cloning Google Drive support
- Stop duplicate cloning Google Drive & mirroring Mega support
- Tar/Unzip Google Drive link support
- Select files from Torrent before downloading
- Sudo with Database support
- Multiple Trackers support
- Extracting tar.xz support
- Counting Google Drive link
- Heroku config support
- View Link button
- Shell and Executor
- Speedtest
- Torrent search Supported:
nyaa.si, sukebei, 1337x, piratebay,
tgx, yts, eztv, torlock, rarbg
- Direct links Supported:
letsupload.io, hxfile.co, anonfiles.com, bayfiles.com, antfiles,
fembed.com, fembed.net, femax20.com, layarkacaxxi.icu, fcdn.stream,
sbplay.org, naniplay.com, naniplay.nanime.in, naniplay.nanime.biz, sbembed.com,
streamtape.com, streamsb.net, feurl.com, pixeldrain.com, racaty.net,
1fichier.com, 1drv.ms (Only works for file not folder or business account),
uptobox.com (Uptobox account must be premium), solidfiles.com
- Mirroring direct download links, Torrent, and Telegram files to Google Drive
- Mirroring Mega.nz links to Google Drive (If your Mega account not premium, it will limit 5GB/6 hours)
- Copy files from someone's Drive to your Drive (Using Autorclone)
- Download/Upload progress, Speeds and ETAs
- Mirror all Youtube-dl supported links
- Docker support
- Uploading to Team Drive
- Index Link support
- Service Account support
- Delete files from Drive
- Shortener support
- Custom Filename (Only for URL, Telegram files and Youtube-dl. Not for Mega links and Magnet/Torrents)
- Extracting password protected files, using custom filename and download from password protected Index Links see these examples:
- Extract these filetypes and uploads to Google Drive
ZIP, RAR, TAR, 7z, ISO, WIM, CAB, GZIP, BZIP2,
APM, ARJ, CHM, CPIO, CramFS, DEB, DMG, FAT,
HFS, LZH, LZMA, LZMA2, MBR, MSI, MSLZ, NSIS,
NTFS, RPM, SquashFS, UDF, VHD, XAR, Z.
Deploying is pretty much straight forward and is divided into several steps as follows:
- Clone this repo:
git clone https://github.com/Spark-X-Cloud/SparkXcloud-Gdrive-MirrorBot/
cd mirrorbot
- Install requirements For Debian based distros
sudo apt install python3 python3-pip
Install Docker by following the official Docker docs
- For Arch and it's derivatives:
sudo pacman -S docker python
- Install dependencies for running setup scripts:
pip3 install -r requirements-cli.txt
For Service Account to work, you must set
USE_SERVICE_ACCOUNTS
= "True" in config file or environment variables. NOTE: Using Service Accounts is only recommended while uploading to a Team Drive.
1. Generate Service Accounts. What is Service Account?
Let us create only the Service Accounts that we need.
Warning: Abuse of this feature is not the aim of this project and we do NOT recommend that you make a lot of projects, just one project and 100 SAs allow you plenty of use, its also possible that over abuse might get your projects banned by Google.
NOTE: If you have created SAs in past from this script, you can also just re download the keys by running:
python3 gen_sa_accounts.py --download-keys $PROJECTID
NOTE: 1 Service Account can upload/copy around 750 GB a day, 1 project can make 100 Service Accounts so you can upload 75 TB a day or clone 2 TB from each file creator (uploader email).
Choose one of these methods
- List your projects ids
python3 gen_sa_accounts.py --list-projects
- Enable services automatically by this command
python3 gen_sa_accounts.py --enable-services $PROJECTID
- Create Sevice Accounts to current project
python3 gen_sa_accounts.py --create-sas $PROJECTID
- Download Sevice Accounts as accounts folder
python3 gen_sa_accounts.py --download-keys $PROJECTID
python3 gen_sa_accounts.py --quick-setup 1 --new-only
A folder named accounts will be created which will contain keys for the Service Accounts.
Choose one of these methods
- Mount accounts folder
cd accounts
- Grab emails form all accounts to emails.txt file that would be created in accounts folder
For Windows using PowerShell
$emails = Get-ChildItem .\**.json |Get-Content -Raw |ConvertFrom-Json |Select -ExpandProperty client_email >>emails.txt
For Linux
grep -oPh '"client_email": "\K[^"]+' *.json > emails.txt
- Unmount acounts folder
cd ..
Then add emails from emails.txt to Google Group, after that add this Google Group to your Shared Drive and promote it to manager and delete email.txt file from accounts folder
- Run:
python3 add_to_team_drive.py -d SharedTeamDriveSrcID
1. Using Railway
- Go to railway and create account
- Start new project
- Press on
Provision PostgreSQL
- After creating database press on
PostgresSQL
- Go to
Connect
column - Copy
Postgres Connection URL
and fillDATABASE_URL
variable with it
2. Using Heroku PostgreSQL
3. Using ElephantSQL
- Go to elephantsql and create account
- Hit
Create New Instance
- Follow the further instructions in the screen
- Hit
Select Region
- Hit
Review
- Hit
Create instance
- Select your database name
- Copy your database url, and fill
DATABASE_URL
variable with it
Bot commands to be set in @BotFather
mirror - Mirror
zipmirror - Mirror and upload as zip
unzipmirror - Mirror and extract files
qbmirror - Mirror torrent using qBittorrent
qbzipmirror - Mirror torrent and upload as zip using qb
qbunzipmirror - Mirror torrent and extract files using qb
leech - Leech
zipleech - Leech and upload as zip
unzipleech - Leech and extract files
qbleech - Leech torrent using qBittorrent
qbzipleech - Leech torrent and upload as zip using qb
qbunzipleech - Leech torrent and extract using qb
clone - Copy file/folder to Drive
count - Count file/folder of Drive
watch - Mirror yt-dlp supported link
zipwatch - Mirror yt-dlp supported link as zip
leechwatch - Leech through yt-dlp supported link
leechzipwatch - Leech yt-dlp support link as zip
leechset - Leech settings
setthumb - Set thumbnail
status - Get Mirror Status message
rsslist - List all subscribed rss feed info
rssget - Get specific No. of links from specific rss feed
rsssub - Subscribe new rss feed
rssunsub - Unsubscribe rss feed by title
rssset - Rss Settings
list - Search files in Drive
search - Search for torrents with API
cancel - Cancel a task
cancelall - Cancel all tasks
del - Delete file/folder from Drive
log - Get the Bot Log
shell - Run commands in Shell
restart - Restart the Bot
stats - Bot Usage Stats
ping - Ping the Bot
help - All cmds with description
- Visit the Google Cloud Console
- Go to the OAuth Consent tab, fill it, and save.
- Go to the Credentials tab and click Create Credentials -> OAuth Client ID
- Choose Desktop and Create.
- Use the download button to download your credentials.
- Move that file to the root of mirrorbot, and rename it to credentials.json
- Visit Google API page
- Search for Drive and enable it if it is disabled
- Finally, run the script to generate token.pickle file for Google Drive:
pip install google-api-python-client google-auth-httplib2 google-auth-oauthlib
python3 generate_drive_token.py
- Start Docker daemon (skip if already running):
sudo dockerd
- Build Docker image:
docker build . --rm --force-rm --compress --no-cache=true --pull --file Dockerfile -t mirrorbot
- Run the image:
sudo docker run mirrorbot
NOTE: If you want to use port other than 80, change it in docker-compose.yml also.
sudo apt install docker-compose
- Build and run Docker image:
sudo docker-compose up
- After editing files with nano for example (nano start.sh):
sudo docker-compose up --build
- To stop the image:
sudo docker-compose stop
- To run the image:
sudo docker-compose start
- Tutorial video from Tortoolkit repo for docker-compose and checking ports
For Service Account to work, you must set USE_SERVICE_ACCOUNTS="True" in config file or environment variables, Many thanks to AutoRClone for the scripts. NOTE: Using Service Accounts is only recommended while uploading to a Team Drive.
Generate Service Accounts. What is Service Account
Click Here For More Details
Let us create only the Service Accounts that we need. Warning: abuse of this feature is not the aim of this project and we do NOT recommend that you make a lot of projects, just one project and 100 SAs allow you plenty of use, its also possible that over abuse might get your projects banned by Google.
NOTE: 1 Service Account can copy around 750gb a day, 1 project can make 100 Service Accounts so that's 75tb a day, for most users this should easily suffice.
python3 gen_sa_accounts.py --quick-setup 1 --new-only
A folder named accounts will be created which will contain keys for the Service Accounts.
Or you can create Service Accounts to current project, no need to create new one
- List your projects ids
python3 gen_sa_accounts.py --list-projects
- Enable services automatically by this command
python3 gen_sa_accounts.py --enable-services $PROJECTID
- Create Sevice Accounts to current project
python3 gen_sa_accounts.py --create-sas $PROJECTID
- Download Sevice Accounts as accounts folder
python3 gen_sa_accounts.py --download-keys $PROJECTID
If you want to add Service Accounts to Google Group, follow these steps
- Mount accounts folder
cd accounts
- Grab emails form all accounts to emails.txt file that would be created in accounts folder
grep -oPh '"client_email": "\K[^"]+' *.json > emails.txt
- Unmount acounts folder
cd -
Then add emails from emails.txt to Google Group, after that add Google Group to your Shared Drive and promote it to manager.
NOTE: If you have created SAs in past from this script, you can also just re download the keys by running:
python3 gen_sa_accounts.py --download-keys project_id
- Run:
python3 add_to_team_drive.py -d SharedTeamDriveSrcID
Youtube-dl authentication using .netrc file
For using your premium accounts in Youtube-dl or for protected Index Links, edit the netrc file according to following format:
machine host login username password my_youtube_password
For Index Link with only password without username, even http auth will not work, so this is the solution.
machine example.workers.dev password index_password
Where host is the name of extractor (eg. Youtube, Twitch). Multiple accounts of different hosts can be added each separated by a new line.