From 06553430ba17d9752a80cf76e69051bb9f391aef Mon Sep 17 00:00:00 2001 From: Hafitz Setya Date: Sat, 4 Sep 2021 11:54:15 +0700 Subject: [PATCH] Update README.md - Updated guide for filling MULTI_SEARCH_URL config - Fixed lot of typos - Added credit for service account script. Co-authored-by: Ronin Signed-off-by: breakdowns --- README.md | 85 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 43 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index bc534b0..f7890f4 100644 --- a/README.md +++ b/README.md @@ -8,29 +8,29 @@ ![Docker Pulls](https://img.shields.io/docker/pulls/breakdowns/mega-sdk-python?label=Docker%20Pull) [![Channel](https://img.shields.io/badge/Join%20Channel-!-red)](https://t.me/SlamMirrorUpdates) -**Slam Mirror Bot** is a _multipurpose_ Telegram Bot writen in Python for mirroring files on the Internet to our beloved Google Drive. Based on [python-aria-mirror-bot](https://github.com/lzzy12/python-aria-mirror-bot) +**Slam Mirror Bot** is a _multipurpose_ Telegram Bot written in Python for mirroring files on the Internet to our beloved Google Drive. Based on [python-aria-mirror-bot](https://github.com/lzzy12/python-aria-mirror-bot) # Features supported:
Click Here For More Details ## Additional Features -- Qbittorrent +- qBittorrent - Size limiting for Torrent/Direct, Tar/Unzip, Mega and clone -- Stop duplicate for all except qbittorrent tasks and youtube-dl -- Tar/Unzip Google Drive link support +- Stop duplicates for all tasks except for qBittorrent and youtube-dl tasks +- Tar/Unzip G-Drive link - Select files from Torrent before downloading using qbittorrent - Sudo with or without Database - Multiple Trackers support - Extracting **tar.xz** support -- Counting Google Drive link -- View Link button +- Counting files/folders from Google Drive link +- View Link button instead of direct download link - Shell and Executor - Speedtest - Status Pages for unlimited tasks - Clone status +- Search in multiple Drive folder/TD - Many bugs has been fixed -- Multiple search Google Drive from Folder/Team Drive - Direct links Supported: ``` letsupload.io, hxfile.co, anonfiles.com, bayfiles.com, antfiles, @@ -43,7 +43,7 @@ uptobox.com (Uptobox account must be premium), solidfiles.com ## From Original and Other Repos - 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) +- Mirroring Mega.nz links to Google Drive (If you have non-premium Mega account, it will limit download to 5GB per 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 @@ -53,8 +53,8 @@ uptobox.com (Uptobox account must be premium), solidfiles.com - 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: +- Custom Filename (Only for direct links, Telegram files and Youtube-dl. Not for Mega links and Torrents) +- Extracting and downloading password protected index links. See these examples:

- Extract these filetypes and uploads to Google Drive @@ -126,55 +126,55 @@ cp config_sample.env config.env ``` _____REMOVE_THIS_LINE_____=True ``` -Fill up rest of the fields. Meaning of each fields are discussed below: +Fill up rest of the fields. Meaning of each field is discussed below: ### Required Field -- `BOT_TOKEN`: The Telegram bot token that you get from [@BotFather](https://t.me/BotFather) -- `TELEGRAM_API`: This is to authenticate to your Telegram account for downloading Telegram files. You can get this from https://my.telegram.org DO NOT put this in quotes. -- `TELEGRAM_HASH`: This is to authenticate to your Telegram account for downloading Telegram files. You can get this from https://my.telegram.org -- `OWNER_ID`: The Telegram user ID (not username) of the Owner of the bot +- `BOT_TOKEN`: The Telegram Bot Token that you got from [@BotFather](https://t.me/BotFather) +- `TELEGRAM_API`: This is to authenticate your Telegram account for downloading Telegram files. You can get this from https://my.telegram.org. **NOTE**: DO NOT put this in quotes. +- `TELEGRAM_HASH`: This is to authenticate your Telegram account for downloading Telegram files. You can get this from https://my.telegram.org +- `OWNER_ID`: The Telegram User ID (not username) of the Owner of the bot - `GDRIVE_FOLDER_ID`: This is the folder ID of the Google Drive Folder to which you want to upload all the mirrors. - `DOWNLOAD_DIR`: The path to the local folder where the downloads should be downloaded to -- `DOWNLOAD_STATUS_UPDATE_INTERVAL`: A short interval of time in seconds after which the Mirror progress message is updated. (I recommend to keep it `5` seconds at least) +- `DOWNLOAD_STATUS_UPDATE_INTERVAL`: A short interval of time in seconds after which the Mirror progress/status message is updated. (I recommend to keep it to `5` seconds at least) - `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 never automatically delete messages) ### Optional Field - `ACCOUNTS_ZIP_URL`: Only if you want to load your Service Account externally from an Index Link. Archive the accounts folder to a zip file. Fill this with the direct link of that file. - `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. -- `DATABASE_URL`: Your Database URL. See [Generate Database](https://github.com/SlamDevs/slam-mirrorbot/tree/master#generate-database) to generate database (**NOTE**: If you use database you can save your sudo id permanent using `/addsudo` command). -- `AUTHORIZED_CHATS`: Fill user_id and chat_id (not username) of you want to authorize, Seprate them with space, Examples: `-0123456789 -1122334455 6915401739`. -- `SUDO_USERS`: Fill user_id (not username) of you want to sudoers, Seprate them with space, Examples: `0123456789 1122334455 6915401739` (**NOTE**: If you want save sudo id permanent without database, you must fill your sudo id there). +- `MULTI_SEARCH_URL`: To use search/list in multiple TD/folder. Run driveid.py in your terminal and follow it. It will generate a file **drive_folder** when you finish. Upload that file [here](https://gist.github.com/) with the same file name. Open the raw file of that gist, it's URL will be your required config. Check wiki for gist related help. +- `DATABASE_URL`: Your Database URL. See [Generate Database](https://github.com/SlamDevs/slam-mirrorbot/tree/master#generate-database) to generate database (**NOTE**: If you use database you can save your Sudo ID permanently using `/addsudo` command). +- `AUTHORIZED_CHATS`: Fill user_id and chat_id (not username) of groups/users you want to authorize. Separate them with space, Examples: `-0123456789 -1122334455 6915401739`. +- `SUDO_USERS`: Fill user_id (not username) of users whom you want to give sudo permission. Separate them with space, Examples: `0123456789 1122334455 6915401739` (**NOTE**: If you want to save Sudo ID permanently without database, you must fill your Sudo Id here). - `IS_TEAM_DRIVE`: Set to `True` if `GDRIVE_FOLDER_ID` is from a Team Drive else `False` or Leave it empty. - `USE_SERVICE_ACCOUNTS`: (Leave empty if unsure) Whether to use Service Accounts or not. For this to work see [Using Service Accounts](https://github.com/SlamDevs/slam-mirrorbot#generate-service-accounts-what-is-service-account) section below. - `INDEX_URL`: Refer to https://gitlab.com/ParveenBhadooOfficial/Google-Drive-Index The URL should not have any trailing '/' -- `MEGA_API_KEY`: Mega.nz api key to mirror mega.nz links. Get it from [Mega SDK Page](https://mega.nz/sdk) -- `MEGA_EMAIL_ID`: Your email id you used to sign up on mega.nz for using premium accounts (Leave th) -- `MEGA_PASSWORD`: Your password for your mega.nz account +- `MEGA_API_KEY`: Mega.nz API key to mirror mega.nz links. Get it from [Mega SDK Page](https://mega.nz/sdk) +- `MEGA_EMAIL_ID`: Your E-Mail ID used to sign up on mega.nz for using premium account (Leave though) +- `MEGA_PASSWORD`: Your Password for your mega.nz account - `BLOCK_MEGA_FOLDER`: If you want to remove mega.nz folder support, set it to `True`. - `BLOCK_MEGA_LINKS`: If you want to remove mega.nz mirror support, set it to `True`. - `STOP_DUPLICATE`: (Leave empty if unsure) if this field is set to `True`, 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 using filehash, so this feature is not perfect yet) -- `CLONE_LIMIT`: To limit cloning Google Drive (leave space between number and unit, Available units is (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` -- `MEGA_LIMIT`: To limit downloading Mega (leave space between number and unit, Available units is (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` -- `TORRENT_DIRECT_LIMIT`: To limit the Torrent/Direct mirror size, Leave space between number and unit. Available units is (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` -- `TAR_UNZIP_LIMIT`: To limit mirroring as Tar or unzipmirror. Available units is (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` -- `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 the END of link from browser link bar is `?a=view`, if yes make it `True` it will work (Compatible with https://gitlab.com/ParveenBhadooOfficial/Google-Drive-Index Code) +- `CLONE_LIMIT`: To limit the size of Google Drive folder/file which you can clone (leave space between number and unit, Available units are (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` +- `MEGA_LIMIT`: To limit the size of Mega download (leave space between number and unit, available units are (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` +- `TORRENT_DIRECT_LIMIT`: To limit the Torrent/Direct mirror size, leave space between number and unit. Available units are (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` +- `TAR_UNZIP_LIMIT`: To limit the size of mirroring as Tar or unzipmirror. Available units are (gb or GB, tb or TB), Examples: `100 gb, 100 GB, 10 tb, 10 TB` +- `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 it `True` it will work (Compatible with https://gitlab.com/ParveenBhadooOfficial/Google-Drive-Index Code) - `UPTOBOX_TOKEN`: Uptobox token to mirror uptobox links. Get it from [Uptobox Premium Account](https://uptobox.com/my_account). -- `HEROKU_EMAIL`: Heroku Account email Id in which the above app will be deployed (**NOTE**: Only needed if you deploying on Heroku with Github Workflow). +- `HEROKU_EMAIL`: E-Mail of the Heroku account in which the above app will be deployed (**NOTE**: Only needed if you are deploying on Heroku with Github Workflow). - `HEROKU_API_KEY`: (Only if you deploying on Heroku) Your Heroku API key, get it from https://dashboard.heroku.com/account. - `HEROKU_APP_NAME`: (Only if you deploying on Heroku) Your Heroku app name. - `IGNORE_PENDING_REQUESTS`: If you want the bot to ignore pending requests after it restarts, set this to `True`. -- `STATUS_LIMIT`: Status limit with buttons (**NOTE**: Recommend limit status to `4` tasks max). +- `STATUS_LIMIT`: Limit the no. of tasks shown in status message with button. (**NOTE**: Recommended limit is `4` tasks at max). - `IS_VPS`: (Only for VPS) Don't set this to `True` even if you are using VPS, unless facing error with web server. Also go to start.sh and replace `$PORT` by `80` or any port you want to use. - `SERVER_PORT`: (Only if IS_VPS is `True`) Base URL Port -- `BASE_URL_OF_BOT`: (Required for Heroku to avoid sleep) Valid BASE URL of where the bot is deploy. Ip/domain of your bot like `http://myip` or if you have chosen other port then `80` then `http://myip:port`, for Heroku fill `https://yourappname.herokuapp.com` (**NOTE**: No slash at the end), still got idling? You can use http://cron-job.org to ping your Heroku app. -- `MULTI_SEARCH_URL`: This is for Multiple Drive Search, Make `drive_folder` file with format `anyname folder/td(id) indexlink`. Examples: `Slam 5l4mm1R0r80T yourindexlink.workers.dev` then upload it to `root` repo or you can upload to https://gist.github.com (**NOTE**: Remove commit id from the link, like config raw link check Heroku guide). -- `SHORTENER_API`: Fill your Shortener api key if you are using Shortener. -- `SHORTENER`: if you want to use Shortener in Gdrive and index link, fill Shortener url here. Examples: +- `BASE_URL_OF_BOT`: (Required for Heroku to avoid sleep/idling) Valid BASE URL of app where the bot is deployed. IP/Domain of your bot like `http://myip` or if you have chosen other port then `80` then `http://myip:port`, for Heroku fill `https://yourappname.herokuapp.com` (**NOTE**: Do not put slash at the end), still got idling? You can use http://cron-job.org to ping your Heroku app. +- `SHORTENER_API`: Fill your Shortener API key if you are using Shortener. +- `SHORTENER`: if you want to use Shortener in G-Drive and index link, fill Shortener URL here. Examples: ``` exe.io, gplinks.in, shrinkme.io, urlshortx.com, shortzon.com ``` -Above are the supported url Shorteners. Except these only some url Shorteners are supported. +Above are the supported URL Shorteners. Except these only some URL Shorteners are supported. ### Add more buttons (Optional Field) -Three buttons are already added of Drive Link, Index Link, and View Link, you can add extra buttons, if you don't know what are below entries, simply leave them, don't fill anything in them. +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 below entries, simply leave them, don't fill anything in them. - `BUTTON_FOUR_NAME`: - `BUTTON_FOUR_URL`: - `BUTTON_FIVE_NAME`: @@ -199,7 +199,7 @@ pip install google-api-python-client google-auth-httplib2 google-auth-oauthlib python3 generate_drive_token.py ``` -## Deploy On VPS +## Deploying On VPS **IMPORTANT NOTE**: In start.sh you must replace `$PORT` with 80 or any other port you want to use @@ -273,7 +273,7 @@ Many thanks to [AutoRClone](https://github.com/xyou365/AutoRclone) for the scrip 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. +**NOTE:** 1 Service Account can copy around 750 GB a day, 1 project can make 100 Service Accounts so that's 75 TB a day, for most users this should easily suffice. ``` python3 gen_sa_accounts.py --quick-setup 1 --new-only ``` @@ -340,15 +340,16 @@ Where host is the name of extractor (eg. Youtube, Twitch). Multiple accounts of # Credits Thanks to: -- [`out386`](https://github.com/out386) heavily inspired from Telegram Bot which is written in JS -- [`Izzy12`](https://github.com/lzzy12) for build up this bot from scratch -- [`jaskaranSM`](https://github.com/jaskaranSM) for build up this bot from scratch +- [`out386`](https://github.com/out386) heavily inspired from his Telegram Bot written in Typescript +- [`Izzy12`](https://github.com/lzzy12) for build up of this bot from scratch +- [`jaskaranSM`](https://github.com/jaskaranSM) for build up of this bot from scratch - [`Dank-del`](https://github.com/Dank-del) for base repo - [`magneto261290`](https://github.com/magneto261290) for some features - [`SVR666`](https://github.com/SVR666) for some features & fixes - [`anasty17`](https://github.com/anasty17) for some features & help - [`breakdowns`](https://github.com/breakdowns) for slam-mirrorbot - [`zevtyardt`](https://github.com/zevtyardt) for some direct links -- [`yash-dk`](https://github.com/yash-dk) for implementation qBittorrent on Python +- [`yash-dk`](https://github.com/yash-dk) for implementation of qBittorrent on Python +- [`xyou365`](https://github.com/xyou365) for Service Accounts script. -And many more people who aren't mentioned here, but may be found in [Contributors](https://github.com/SlamDevs/slam-mirrorbot/graphs/contributors). +And many more people who aren't mentioned here, but can be found in [Contributors](https://github.com/SlamDevs/slam-mirrorbot/graphs/contributors).