Kubespider logo

💥 A global resource download orchestration system

GitHub release
Total Downloads
GitHub stars
GitHub license

English | 简体中文

I am a Cloud Computing Engineer🤓, with a focus on Serverless, FinOps, and Runtime. In my spare time, I developed Kubespider to utilize an idle server in a local area network as a NAS, enabling automatic downloads of TV series, triggering downloads from a local laptop, and adapting to various websites such as YouTube and BiliBili, as well as different types of resources such as TV series, movies, and music.

Having been exposed to Terraform, I was impressed by its versatility and inspired to create Kubespider as a general download orchestration system that is compatible with various resource platforms and download software. Kubespider supports multiple download methods, including request trigger, cycle trigger, and update trigger, making it the most comprehensive and unified solution for resource downloads.

System architecture

To realize a general download orchestration system, it is necessary to adapt various resource websites and download software, so these two parts are abstracted from the core functions:

  • kubespider-core: The core module of Kubespider accepts the trigger download request, calls the resource provider for resolution (it will eventually be resolved into a standard mode, such as the user enters the bilibili blogger address, and the corresponding resource provider outputs the mp4 file address download list), and finally calls the download provider to implement Download; this module will also periodically call providers (such as TV series provider) to download additional resources.
  • source-provider:The provider of each resource website accepts input of general resource addresses, and outputs standard resource address URLs, such as the personal homepage of a YouTuber, and outputs all mp4 download addresses of the blogger’s videos. The configuration file is in .config/source_provider.cfg.
  • download-provider:The provider of each download software receives the request task from kubespider-core, and calls the corresponding service to realize the download. The configuration file is in .config/download_provider.cfg.

💽 Installation


  1. The operating computer and your server are on the same LAN. (I haven’t tried the installation not in the same LAN yet)
  2. The server is a Linux system。
  3. Docker is installed on the server。

Default installation(Deploy with Docker)

To adapt to multiple resource platforms, Kubespider provides many adapters. Enable or disable these adapters according to your needs. The configuration file is in the .config folder:

1.Download the repository and install

git clone https://github.com/jwcesign/kubespider.git
cd kubespider
bash hack/install_kubespider.sh

Output like:

  • This step will install Kubespide and Aria2 resource downloader as the default downloader.
  • After installation, all downloaded files will be stored in ${HOME}/kubespider/nas.
  • Configuration files are located in ${HOME}/kubespider/.config.
  • 2.Connect to aria2

    For checking the download tasks on your server conveniently, go to the chrome store to download AriaNg plugin.

    Then connect, the plugin configuration is as follows(shown at the end of the script install_kubespider.sh execution output):

    Of course, it is not necessary, you can also use the desktop program to connect: AriaNg

    3.Install Chrome plugin

    With Kubespider Chrome plugin, you can get a better experience.

    After step 1 has been done, open chrome, then install Kubespider plugin, and configure it as follows(The server address is http://:3080):

    If I want to download a movie, I can right click and send the download task to Kubespider(demo website):

    Then with aria2 chrome plugin, you can see the download task starts:

    4.More (Optional)

    • Install Plex, watch videos on multiple platforms, install now.
    • Install Baidu network disk(only in china), download in the background, install now.
    • Install Thunder(only in china), download in the background, install now.

    🔧 Feature list

    Source provider

    As metioned before, the source provider is used to adpot to different websites, and download related resources based on conditions:

    Source Provider Support Purpose Configuration
    mikanani source provider Yes Automatically download updated anime link
    btbtt12 source provider Yes Trigger download resource in btbtt12 website link
    meijutt source provider Yes Download updated TV series link
    YouTube source provider TBD Trigger download YouTube video TBD

    Download provider

    In order to make full use of the exisiting download software in the open source community(For example, YouTube hasdedicated download software), the following software is current supported:

    Download Software Support Configuration
    aria2 Yes link
    xunlei Yes link
    qBittorrent Yes link

    Basic feature

    Currently, the following file types are supported to trigger downloading:

    Download Types Support
    magnet Yes
    torrent Yes
    general(jpg, mp4, etc.) Yes

    Please refer to link for how to trigger the download.

    🤝 Contribution PRs Welcome

    If you are interested in participating in joint development, welcome to STAR/FORK/PR, please check link for Roadmap.

    • For how to develop/debug Kubespider, please see link.
    • For how to implement a resource provider for a resource website, please see link.
    • For how to implement a download provider for download software, please see link.
    • For how to develop chrome extension webhook, please see link.
    • For how to implement other webhook trigger tools, please see link.

    📝 Disclaimer

    All downloading and use of the software are deemed to have carefully read and fully agreed to the following terms:

    • The software is only for personal learning and communication, and it is strictly prohibited for commercial and bad purposes.
    • If any commercial behavior and bad use are found, the software author has the right to revoke the right to use.
    • The risk of using this software will be entirely borne by him, and the software author will not bear any responsibility.
    • Except for the terms of service indicated in the software, the author of this software is not responsible for any accidents, negligence, contract damage, defamation, copyright or other intellectual property infringement and any losses caused by improper use of this software, and also no legal responsibility is assumed.
    • The author of the software will not be responsible for the interruption of services or other defects caused by force majeure or uncontrollable reasons such as hacker attacks, communication line interruptions, etc., which cause users to fail to use normally but will try their best to reduce losses or impacts caused to users.
    • For issues not covered in this statement, please refer to relevant national laws and regulations. When this statement conflicts with relevant national laws and regulations, the national laws and regulations shall prevail.
    • The copyright of this software statement and its right to modify, update and final interpretation belong to the software author.

    Read More

    By |2023-03-18T10:16:22+00:00March 18th, 2023|Education|0 Comments

    Leave A Comment