Skip to content

Latest commit

 

History

History
395 lines (296 loc) · 23.6 KB

README.md

File metadata and controls

395 lines (296 loc) · 23.6 KB

WZML-X Logo

This repository is a feature-enhanced version of the mirror-leech-telegram-bot. It integrates various improvements from multiple sources, expanding functionality while maintaining efficiency. Unlike the base repository, this version is fully deployable on Heroku.

---

🗄 Deployment Guide (vps)

View All Steps Click Here
  1. Prerequisites
    • Tutorial Video from A to Z: (Latest Video)

  2. Installing requirements
    • Clone this repo:
    git clone https://github.com/SilentDemonSD/WZML-X mirrorbot/ && cd mirrorbot
    
  3. Build And Run the Docker Image

    Make sure you still mount the app folder and installed the docker from official documentation.

    • There are two methods to build and run the docker:
      1. Using official docker commands.
      2. Using docker-compose. (Recommended)

    Build And Run The Docker Image Using Official Docker Commands

    • Start Docker daemon (SKIP if already running, mostly you don't need to do this):
    sudo dockerd
    
    • Build Docker image:
    sudo docker build . -t wzmlx
    
    • Run the image:
    sudo docker run -p 80:80 -p 8080:8080 wzmlx
    
    • To stop the running image:
    sudo docker ps
    
    sudo docker stop id
    

    Build And Run The Docker Image Using docker-compose

    NOTE: If you want to use ports other than 80 and 8080 for torrent file selection and rclone serve respectively, change it in docker-compose.yml also.

    • Install docker-compose
    sudo apt install docker-compose
    
    • Build and run Docker image or to view current running image:
    sudo docker-compose up
    
    • After editing files with nano for example (nano start.sh):
    sudo docker-compose up --build
    
    • To stop the running image:
    sudo docker-compose stop
    
    • To run the image:
    sudo docker-compose start
    
    • To get latest log from already running image (after mounting the folder):
    sudo docker-compose up
    
    • Tutorial video from Tortoolkit repo for docker-compose and checking ports


    Docker Notes

    IMPORTANT NOTES:

    1. Set BASE_URL_PORT and RCLONE_SERVE_PORT variables to any port you want to use. Default is 80 and 8080 respectively.
    2. You should stop the running image before deleting the container and you should delete the container before the image.
    3. To delete the container (this will not affect on the image):
    sudo docker container prune
    
    1. To delete the images:
    sudo docker image prune -a
    
    1. Check the number of processing units of your machine with nproc cmd and times it by 4, then edit AsyncIOThreadsCount in qBittorrent.conf.

📝 Variables Description:

View All Variables Click Here
  1. Required Fields
    • BOT_TOKEN: The Telegram Bot Token that you got from @BotFather. Str

    • OWNER_ID: The Telegram User ID (not username) of the Owner of the bot. Int

    • 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. Str

  2. Optional Fields
    • USER_SESSION_STRING: To download/upload from your telegram account and to send rss. To generate session string use this command python3 generate_string_session.py after mounting repo folder for sure. Str. NOTE: You can't use bot with private message. Use it with superGroup.
    • DATABASE_URL: Your Mongo Database URL (Connection string). Follow this Generate Database to generate database. Data will be saved in Database: auth and sudo users, users settings including thumbnails for each user, rss data and incomplete tasks. NOTE: You can always edit all settings that saved in database from the official site -> (Browse collections). Str
    • DOWNLOAD_DIR: The path to the local folder where the downloads should be downloaded to. Str
    • CMD_SUFFIX: commands index number. This number will added at the end all commands. Str|Int
    • AUTHORIZED_CHATS: Fill user_id and chat_id of groups/users you want to authorize. Separate them by space. Int
    • SUDO_USERS: Fill user_id of users whom you want to give sudo permission. Separate them by space. Int
    • BLACKLIST_USERS : Fill user_id of users you wish to prohibit from using the bot. Separate them by space. Int
    • STATUS_LIMIT: Limit the no. of tasks shown in status message with buttons. Default is 10. NOTE: Recommended limit is 4 tasks. Int
    • DEFAULT_UPLOAD: Whether rc to upload to RCLONE_PATH or gd to upload to GDRIVE_ID or ddl to upload to DDL. Default is gd. Read More HERE.Str
    • STATUS_UPDATE_INTERVAL: Time in seconds after which the progress/status message will be updated. Recommended 10 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
    • INCOMPLETE_TASK_NOTIFIER: Get incomplete task messages after restart. Require database and superGroup. Default is False. Bool
    • SET_COMMANDS: Automatically set the Bot Commands no need to set from @botfather. Default is False. Bool
    • EXTENSION_FILTER: File extensions that won't upload/clone. Separate them by space. No need to add . Str
    • YT_DLP_OPTIONS: Default yt-dlp options. Check all possible options HERE or use this script to convert cli arguments to api options. Format: key:value|key:value|key:value. Add ^ before integer or float, some numbers must be numeric and some string. str
      • Example: "format:bv*+mergeall[vcodec=none]|nocheckcertificate:True"
    • FSUB_IDS: Fill chat_id(-100xxxxxx) of groups/channel you want to force subscribe. Separate them by space. Int
      • Note: Bot should be added in the filled chat_id as admin
    • BOT_PM: File/links send to the BOT PM. Default is False. Bool
  3. GDrive Tools
    • GDRIVE_ID: This is the Folder/TeamDrive ID of the Google Drive OR root to which you want to upload all the mirrors using google-api-python-client. Str
    • USER_TD_MODE: Enable the User-TD feature i.e user can upload file into their own drive. Default is False. Bool
    • USER_TD_SA: Show your SA account in the usetting so that user can add that in its own TD to enable uploading Using SA. SA will be an email/group_email like [email protected]
    • INDEX_URL: Refer to https://gitlab.com/ParveenBhadooOfficial/Google-Drive-Index. Str
    • USE_SERVICE_ACCOUNTS: Whether to use Service Accounts or not, with google-api-python-client. For this to work see Using Service Accounts section below. Default is False. Bool
    • IS_TEAM_DRIVE: Set True if uploading to TeamDrive using google-api-python-client. Default is False. Bool
    • STOP_DUPLICATE: Bot will check file/folder name in Drive incase uploading to GDRIVE_ID. If it's present in Drive then downloading or cloning will be stopped. (NOTE: Item will be checked using name and not hash, so this feature is not perfect yet). Default is False. Bool
    • DISABLE_DRIVE_LINK: Disable drive link button. Default is False. Bool
    • GD_INFO: Description of file/folder uploaded to Google Drive.
  4. API's/Cookies
    • REAL_DEBRID_API: Api of real-debrid.com. Support the Premium Bypass Download limit and support the Cached Magnets.
    • DEBRID_LINK_API : Api of debrid-link.com. Support the Premium Bypass Download limit.
    • FILELION_API: Api of filelions.com to download the link from the filelion site
    • GDTOT_CRYPT: Use Gdtot crpyt to bypass the GDTOT links.
    • JIODRIVE_TOKEN: Use Jiodrive Token to bypass the jiodrive links.
  5. RClone
    • RCLONE_PATH: Default rclone path to which you want to upload all the files/folders using rclone. Str
    • RCLONE_FLAGS: key:value|key|key|key:value . Check here all RcloneFlags. Str
    • RCLONE_SERVE_URL: Valid URL where the bot is deployed to use rclone serve. Format of URL should be http://myip, where myip is the IP/Domain(public) of your bot or if you have chosen port other than 80 so write it in this format http://myip:port (http and not https). Str
    • RCLONE_SERVE_PORT: Which is the RCLONE_SERVE_URL Port. Default is 8080. Int
    • RCLONE_SERVE_USER: Username for rclone serve authentication. Str
    • RCLONE_SERVE_PASS: Password for rclone serve authentication. Str
  6. Update
    • UPSTREAM_REPO: Your github repository link, if your repo is private add https://username:{githubtoken}@github.com/{username}/{reponame} format. Get token from Github settings. So you can update your bot from filled repository on each restart. Str.
      • NOTE: Any change in docker or requirements you need to deploy/build again with updated repo to take effect. DON'T delete .gitignore file. For more information read THIS.
    • UPSTREAM_BRANCH: Upstream branch for update. Default is master. Str
  7. Telegram Leech & Mirror
    • LEECH_SPLIT_SIZE: Size of split in bytes. Default is 2GB. Default is 4GB if your account is premium. Int
    • AS_DOCUMENT: Default type of Telegram file upload. Default is False mean as media. Bool
    • EQUAL_SPLITS: Split files larger than LEECH_SPLIT_SIZE into equal parts size (Not working with zip cmd). Default is False. Bool
    • MEDIA_GROUP: View Uploaded splitted file parts in media group. Default is False. Bool.
    • LEECH_FILENAME_PREFIX: Add custom prefix to leeched file name. Str
    • LEECH_FILENAME_SUFFIX: Add custom suffix to leeched file name. Str
    • LEECH_FILENAME_CAPTION: Add custom caption to leeched file. Str
    • LEECH_FILENAME_REMNAME: Remove custom word from leeched file name. Str
    • MIRROR_FILENAME_PREFIX: Add custom prefix to mirrored file name. Str
    • MIRROR_FILENAME_SUFFIX: Add custom suffix to mirrored file name. Str
    • MIRROR_FILENAME_REMNAME: Remove custom word from mirrored file name. Str
  8. Log Channel/superGroup(Support topics)
    • LEECH_LOG_ID: Chat ID to where leeched files would be uploaded. Int. NOTE: Only available for superGroup/channel. Add -100 before channel/superGroup id. In short don't add bot id or your id!. For topic support make this format chat_id:topic_id
    • MIRROR_LOG_ID: Chat ID to where Mirror files would be Send. Int. NOTE: Only available for superGroup/channel. Add -100 before channel/superGroup id. In short don't add bot id or your id!. For topic support make this format chat_id:topic_id
    • LINKS_LOG_ID: Chat ID to where Link logs would be Send. Int. NOTE: Only available for superGroup/channel. Add -100 before channel/superGroup id. In short don't add bot id or your id!.
      • Note: LEECH_LOG_ID & MIRROR_LOG_ID it's multiple, For multiple id Separate them by space.
      • Warning: leech log is multiple only in case of channel. i.e it doesn't support multiple Topics (for now)
  9. qBittorrent/Aria2c
    • TORRENT_TIMEOUT: Timeout of dead torrents downloading with qBittorrent and Aria2c in seconds. Int
    • BASE_URL: Valid BASE URL where the bot is deployed to use torrent web files selection. Format of URL should be http://myip, where myip is the IP/Domain(public) of your bot or if you have chosen port other than 80 so write it in this format http://myip:port (http and not https). Str
    • BASE_URL_PORT: Which is the BASE_URL Port. Default is 80. Int
    • WEB_PINCODE: Whether to ask for pincode before selecting files from torrent in web or not. Default is False. Bool.
      • Qbittorrent NOTE: If your facing ram issues then set limit for MaxConnections, decrease AsyncIOThreadsCount, set limit of DiskWriteCacheSize to 32 and decrease MemoryWorkingSetLimit from qbittorrent.conf or bsetting command.
  10. RSS
    • RSS_DELAY: Time in seconds for rss refresh interval. Recommended 900 second at least. Default is 900 in sec. Int
    • RSS_CHAT_ID: Chat ID where rss links will be sent. If you want message to be sent to the channel then add channel id. Add -100 before channel id. Int
      • RSS NOTES: RSS_CHAT_ID is required, otherwise monitor will not work. You must use USER_STRING_SESSION --OR-- CHANNEL. If using channel then bot should be added in both channel and group(linked to channel) and RSS_CHAT_ID is the channel id, so messages sent by the bot to channel will be forwarded to group. Otherwise with USER_STRING_SESSION add group id for RSS_CHAT_ID. If DATABASE_URL not added you will miss the feeds while bot offline.
  11. Mega
    • MEGA_EMAIL: E-Mail used to sign-in on mega.nz for using premium account. Str
    • MEGA_PASSWORD: Password for mega.nz account. Str
  12. Queue System
    • QUEUE_ALL: Number of parallel tasks of downloads and uploads. For example if 20 task added and QUEUE_ALL is 8, then the summation of uploading and downloading tasks are 8 and the rest in queue. Int. NOTE: if you want to fill QUEUE_DOWNLOAD or QUEUE_UPLOAD, then QUEUE_ALL value must be greater than or equal to the greatest one and less than or equal to summation of QUEUE_UPLOAD and QUEUE_DOWNLOAD.
    • QUEUE_DOWNLOAD: Number of all parallel downloading tasks. Int
    • QUEUE_UPLOAD: Number of all parallel uploading tasks. Int
  13. Limits
    • DAILY_TASK_LIMIT: Maximum task a user can do in one day. use the Int
    • DAILY_MIRROR_LIMIT: Total size upto which user can Mirror in one day. the default unit is GB. Int
    • DAILY_LEECH_LIMIT: Total size upto which user can Leech in one day. the default unit is GB. Int
    • USER_MAX_TASKS: Limit the Maximum task for users of group at a time. Int
    • BOT_MAX_TASKS: Limit the Maximum task for bots of group at a time. Int
    • TORRENT_LIMIT: To limit the size of torrent download. the default unit is GB. Int
    • DIRECT_LIMIT: To limit the size of direct link download. the default unit is GB. Int
    • GDRIVE_LIMIT: To limit the size of Google Drive folder/file link for leech, Zip, Unzip. the default unit is GB. Int
    • CLONE_LIMIT: To limit the size of Google Drive folder/file which you can clone. the default unit is GB. Int
    • YTDLP_LIMIT: To limit the size of ytdlp download. the default unit is GB. Int
    • PLAYLIST_LIMIT: To limit Maximum Playlist Number. Int
    • LEECH_LIMIT: To limit the Torrent/Direct/ytdlp leech size. the default unit is GB. Int
    • MEGA_LIMIT: To limit the size of Mega download. the default unit is GB. Int
    • STORAGE_THRESHOLD: To leave specific storage free and any download will lead to leave free storage less than this value will be cancelled the default unit is GB. Int
    • USER_TIME_INTERVAL: Time Gap between two consecutive link/file mirror/leech operations. The default value is set to 0 seconds. unit is sec. int
  14. Templates
    • ANIME_TEMPLATE: Set template for anime...
    • IMDB_TEMPLATE: Set your imdb template...
    • MDL_TEMPLATE: Set your MyDramaList template...
  15. Telegraph
    • TITLE_NAME: Title name for Telegraph pages (while using /list command)
    • AUTHOR_NAME: Author name for Telegraph pages
    • AUTHOR_URL: Author URL for Telegraph page
    • COVER_IMAGE: telegraph header image. use graph.org link of image
  16. Extra
    • SAFE_MODE: Include

      • Remove filename from the auth group
      • Remove Leech file index link from auth group (leech index directly send to BOT_PM)
      • Remove Mirror link from auth group (Link directly send to BOT_PM)
        • NOTE: BOT_PM Should be True to get the Links in PM while SAFE_MODE is True
    • DELETE_LINKS: Delete links after used. Default is False. Bool

    • CLEAN_LOG_MSG: Clean log messages i.e remove the LEECH started msg from the leech log. Default is False. Bool

    • SHOW_EXTRA_CMDS: Add old cmds like zipleech... Default is False. Bool

    • TIMEZONE: Set timezone for the bot. Checkout the list to get the proper timezone. Default is Asia/Kolkata.

    • IMAGES: Add multiple telgraph(graph.org) image links that are seperated by spaces.

    • IMG_SEARCH: Put Keyword to Download Images. Sperarte each name by , like anime, iron man, god of war

    • IMG_PAGE: Set the page value for downloading a image. Each page have approx 70 images. Deafult is 1. Int

    • BOT_THEME: Change the theme of bot. For now theme availabe is minimal.

    • EXCEP_CHATS: CHAT_ID of a SuperGroup where you want to disable the logging feature for that specific group. Logging features will remain active in other authorized chats that have been filled. Add -100 before superGroup id. In short don't add bot id or your id!.

  17. M/L Buttons
    • SHOW_MEDIAINFO: Mediainfo button of file. Default is False. Bool
    • SCREENSHOTS_MODE: Enable or Diable generating Screenshots via -ss arg. Default is False. Bool
    • SAVE_MSG: Save Button in each file and link so that every user direcly save it without forwarding. Default is False. Bool
    • SOURCE_LINK: Source button of files and links. Default is False. Bool
  18. Token system
    • TOKEN_TIMEOUT: Token timeout for each group member in sec. Default is 21600. Int
    • LOGIN_PASS: Permanent pass for user to skip the token system
  19. Torrent Search
    • SEARCH_API_LINK: Search api app link. Get your api from deploying this repository. Str
      • 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). Int
    • 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). List

🏅 Bot Authors

Click Here For Description
SilentDemonSD CodeWithWeeb Maverick
Author and DDL, UI Design, More Customs.. Author and Wraps Up Features Co-Author & Bug Tester