-
Notifications
You must be signed in to change notification settings - Fork 513
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #376 from caorushizi/dev/docs
Dev/docs
- Loading branch information
Showing
44 changed files
with
464 additions
and
177 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| <div align="center"> | ||
| <h1>MediaGo</h1> | ||
| <a href="https://downloader.caorushizi.cn/guides.html?form=github">快速开始</a> | ||
| <span> • </span> | ||
| <a href="https://downloader.caorushizi.cn?form=github">官网</a> | ||
| <span> • </span> | ||
| <a href="https://downloader.caorushizi.cn/documents.html?form=github">文档</a> | ||
| <span> • </span> | ||
| <a href="https://github.com/caorushizi/mediago/discussions">Discussions</a> | ||
| <br> | ||
| <br> | ||
|
|
||
| <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/github/downloads/caorushizi/mediago/total"> | ||
| <img alt="GitHub Downloads (all assets, latest release)" src="https://img.shields.io/github/downloads/caorushizi/mediago/latest/total"> | ||
| <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/caorushizi/mediago"> | ||
| <img alt="GitHub forks" src="https://img.shields.io/github/forks/caorushizi/mediago"> | ||
| <br> | ||
| <br> | ||
|
|
||
| <a href="https://trendshift.io/repositories/11083" target="_blank"> | ||
| <img src="https://trendshift.io/api/badge/repositories/11083" alt="caorushizi%2Fmediago | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/> | ||
| </a> | ||
|
|
||
| <hr /> | ||
| </div> | ||
|
|
||
| ## Intro | ||
|
|
||
| This project supports m3u8 video extraction tools, streaming media download, and m3u8 download. | ||
|
|
||
| - **✅ No need to capture packets**: You can easily sniff video resources on web pages using the built-in browser. Choose the resource you want to download from the sniffed resource list—simple and fast. | ||
| - **📱 Mobile playback**: Easily switch between PC and mobile devices seamlessly. Once downloaded, you can watch the video on your phone. | ||
| - **⚡️ Batch download**: Supports downloading multiple videos and live streams simultaneously, ensuring high bandwidth is fully utilized. | ||
| - **🎉 Docker deployment supported**: Supports Docker deployment for the web version, making it convenient and quick. | ||
|
|
||
| ## Quickstart | ||
|
|
||
| To run the code, you'll need Node.js and pnpm. Node.js can be downloaded and installed from the official website, and pnpm can be installed via `npm i -g pnpm`. | ||
|
|
||
| ## Run the code | ||
|
|
||
| ```shell | ||
| # Code download | ||
| git clone https://github.com/caorushizi/mediago.git | ||
|
|
||
| # Installation dependency | ||
| pnpm i | ||
|
|
||
| # Development environment | ||
| pnpm dev | ||
|
|
||
| # Package run | ||
| pnpm release | ||
|
|
||
| # Build a docker image | ||
| docker buildx build -t caorushizi/mediago:latest . | ||
|
|
||
| # docker startup | ||
| docker run -d --name mediago -p 8899:8899 -v /root/mediago:/root/mediago registry.cn-beijing.aliyuncs.com/caorushizi/mediago | ||
|
|
||
| ``` | ||
|
|
||
| ## Releases | ||
|
|
||
| ### v3.0.0 (Released on 2024.10.7) | ||
|
|
||
| #### Software Downloads | ||
|
|
||
| - [【mediago】 Windows (Installer) v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-win32-x64-3.0.0.exe) | ||
| - [【mediago】 Windows (Portable) v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-portable-win32-x64-3.0.0.exe) | ||
| - [【mediago】 macOS ARM64 (Apple Silicon) v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-darwin-arm64-3.0.0.dmg) | ||
| - [【mediago】 macOS x64 (Intel) v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-darwin-x64-3.0.0.dmg) | ||
| - [【mediago】 Linux v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-linux-amd64-3.0.0.deb) | ||
| - 【mediago】 Docker v3.0 `docker run -d --name mediago -p 8899:8899 -v /root/mediago:/root/mediago registry.cn-beijing.aliyuncs.com/caorushizi/mediago:v3.0.0` | ||
|
|
||
| #### Domestic Downloads | ||
|
|
||
| - [【mediago】 Windows (Installer) v3.0.0](https://static.ziying.site/mediago/mediago-setup-win32-x64-3.0.0.exe) | ||
| - [【mediago】 Windows (Portable) v3.0.0](https://static.ziying.site/mediago/mediago-portable-win32-x64-3.0.0.exe) | ||
| - [【mediago】 macOS ARM64 (Apple Silicon) v3.0.0](https://static.ziying.site/mediago/mediago-setup-darwin-arm64-3.0.0.dmg) | ||
| - [【mediago】 macOS x64 (Intel) v3.0.0](https://static.ziying.site/mediago/mediago-setup-darwin-x64-3.0.0-beta.5.dmg) | ||
| - [【mediago】 Linux v3.0.0](https://static.ziying.site/mediago/mediago-setup-linux-amd64-3.0.0.deb) | ||
| - 【mediago】 Docker v3.0 `docker run -d --name mediago -p 8899:8899 -v /root/mediago:/root/mediago registry.cn-beijing.aliyuncs.com/caorushizi/mediago:v3.0.0` | ||
|
|
||
| ### One-click Docker Panel Deployment (Recommended) | ||
|
|
||
| 1. Install the BT Panel by visiting [BT Panel](https://www.bt.cn/new/download.html?r=dk_mediago) and downloading the official version script. | ||
| 2. After installation, log into the BT Panel, click on `Docker` in the menu bar. The first time you enter, it will prompt you to install the `Docker` service. Click to install and follow the instructions to complete the installation. | ||
| 3. Once installed, find `MediaGo` in the application store, click install, configure domain names, and other basic information to complete the installation. | ||
|
|
||
| ### Software Screenshots | ||
|
|
||
|  | ||
|
|
||
| ### Major Updates | ||
|
|
||
| - Support for Docker deployment on the web version | ||
| - Updated desktop UI | ||
|
|
||
| ### Changelog | ||
|
|
||
| - Updated desktop UI | ||
| - Support for Docker deployment on the web version | ||
| - Added video playback, supporting both desktop and mobile playback | ||
| - Fixed issue where the macOS version couldn't display the interface | ||
| - Optimized the batch download interaction | ||
| - Added portable version for Windows (no installation required) | ||
| - Optimized the download list, supporting sniffing multiple videos on a page | ||
| - Supported manual import/export of the favorites list | ||
| - Supported export of the homepage download list | ||
| - Optimized the interaction logic for the "New Download" form | ||
| - Supported opening the app via UrlScheme and adding download tasks | ||
| - Fixed several bugs and enhanced the user experience | ||
|
|
||
| ## Software Screenshots | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Tech Stack | ||
|
|
||
| - React <https://react.dev/> | ||
| - Electron <https://www.electronjs.org> | ||
| - Koa <https://koajs.com> | ||
| - Vite <https://cn.vitejs.dev> | ||
| - Ant Design <https://ant.design> | ||
| - Tailwind CSS <https://tailwindcss.com> | ||
| - Shadcn <https://ui.shadcn.com/> | ||
| - Inversify <https://inversify.io> | ||
| - TypeORM <https://typeorm.io> | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| - N_m2u8DL-CLI from <https://github.com/nilaoda/N_m3u8DL-CLI> | ||
| - N_m3u8DL-RE from <https://github.com/nilaoda/N_m3u8DL-RE> | ||
| - mediago from <https://github.com/caorushizi/hls-downloader> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| <div align="center"> | ||
| <h1>MediaGo</h1> | ||
| <a href="https://downloader.caorushizi.cn/guides.html?form=github">快速开始</a> | ||
| <span> • </span> | ||
| <a href="https://downloader.caorushizi.cn?form=github">官网</a> | ||
| <span> • </span> | ||
| <a href="https://downloader.caorushizi.cn/documents.html?form=github">文档</a> | ||
| <span> • </span> | ||
| <a href="https://github.com/caorushizi/mediago/discussions">Discussions</a> | ||
| <br> | ||
| <br> | ||
|
|
||
| <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/github/downloads/caorushizi/mediago/total"> | ||
| <img alt="GitHub Downloads (all assets, latest release)" src="https://img.shields.io/github/downloads/caorushizi/mediago/latest/total"> | ||
| <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/caorushizi/mediago"> | ||
| <img alt="GitHub forks" src="https://img.shields.io/github/forks/caorushizi/mediago"> | ||
| <br> | ||
| <br> | ||
|
|
||
| <a href="https://trendshift.io/repositories/11083" target="_blank"> | ||
| <img src="https://trendshift.io/api/badge/repositories/11083" alt="caorushizi%2Fmediago | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/> | ||
| </a> | ||
|
|
||
| <hr /> | ||
| </div> | ||
|
|
||
| ## Intro | ||
|
|
||
| 本プロジェクトはm3u8ビデオ抽出ツール、ストリーミングダウンロード、m3u8ダウンロードをサポートしています。 | ||
|
|
||
| - **✅ パケットキャプチャ不要**： ソフトウェアに内蔵されたブラウザを使用して、ウェブページ内のビデオリソースを簡単に検出し、検出したリソースリストからダウンロードしたいリソースを選択することで、シンプルかつ迅速にダウンロードできます。 | ||
| - **📱 モバイル再生**： PCとモバイルデバイス間で簡単にシームレスに切り替えが可能で、ダウンロードが完了した後はスマートフォンでビデオを視聴できます。 | ||
| - **⚡️ バッチダウンロード**： 複数のビデオやライブストリームリソースを同時にダウンロードでき、高速帯域幅を無駄にしません。 | ||
| - **🎉 Dockerデプロイメントサポート**： WebエンドをDockerでデプロイすることができ、簡単かつ便利です。 | ||
|
|
||
| ## Quickstart | ||
|
|
||
| コードを実行するには、Node.jsとpnpmが必要です。Node.jsは公式ウェブサイトからダウンロードしてインストールし、pnpmは`npm i -g pnpm`コマンドでインストールできます。 | ||
|
|
||
| ## コードの実行 | ||
|
|
||
| ```shell | ||
| # コードのダウンロードです | ||
| git clone https://github.com/caorushizi/mediago.git | ||
|
|
||
| # インストール依存症です | ||
| pnpm i | ||
|
|
||
| # 開発環境です | ||
| pnpm dev | ||
|
|
||
| # 梱包して運行します | ||
| pnpm release | ||
|
|
||
| # dockerミラーリングを構築します | ||
| docker buildx build -t caorushizi/mediago:latest . | ||
|
|
||
| # docker启动 | ||
| docker run -d --name mediago -p 8899:8899 -v /root/mediago:/root/mediago registry.cn-beijing.aliyuncs.com/caorushizi/mediago | ||
|
|
||
| ``` | ||
|
|
||
| ## Releases | ||
|
|
||
| ### v3.0.0 (2024.10.7 発売) | ||
|
|
||
| #### ソフトウェアダウンロード | ||
|
|
||
| - [【mediago】 windows（インストーラー版） v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-win32-x64-3.0.0.exe) | ||
| - [【mediago】 windows（ポータブル版） v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-portable-win32-x64-3.0.0.exe) | ||
| - [【mediago】 macos arm64（Appleチップ） v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-darwin-arm64-3.0.0.dmg) | ||
| - [【mediago】 macos x64（Intelチップ） v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-darwin-x64-3.0.0.dmg) | ||
| - [【mediago】 linux v3.0.0](https://github.com/caorushizi/mediago/releases/download/v3.0.0/mediago-setup-linux-amd64-3.0.0.deb) | ||
| - 【mediago】 docker v3.0 `docker run -d --name mediago -p 8899:8899 -v /root/mediago:/root/mediago registry.cn-beijing.aliyuncs.com/caorushizi/mediago:v3.0.0` | ||
|
|
||
| #### 国内ダウンロード | ||
|
|
||
| - [【mediago】 windows（インストーラー版） v3.0.0](https://static.ziying.site/mediago/mediago-setup-win32-x64-3.0.0.exe) | ||
| - [【mediago】 windows（ポータブル版） v3.0.0](https://static.ziying.site/mediago/mediago-portable-win32-x64-3.0.0.exe) | ||
| - [【mediago】 macos arm64（Appleチップ） v3.0.0](https://static.ziying.site/mediago/mediago-setup-darwin-arm64-3.0.0.dmg) | ||
| - [【mediago】 macos x64（Intelチップ） v3.0.0](https://static.ziying.site/mediago/mediago-setup-darwin-x64-3.0.0-beta.5.dmg) | ||
| - [【mediago】 linux v3.0.0](https://static.ziying.site/mediago/mediago-setup-linux-amd64-3.0.0.deb) | ||
| - 【mediago】 docker v3.0 `docker run -d --name mediago -p 8899:8899 -v /root/mediago:/root/mediago registry.cn-beijing.aliyuncs.com/caorushizi/mediago:v3.0.0` | ||
|
|
||
| ### docker 宝塔パネルワンクリックデプロイ（推奨） | ||
|
|
||
| 1. 宝塔パネルをインストールし、[宝塔パネル](https://www.bt.cn/new/download.html?r=dk_mediago) の公式サイトから正式版のスクリプトを選択してインストールします。 | ||
|
|
||
| 2. インストール後、宝塔パネルにログインし、メニューから `Docker` をクリックします。初めてアクセスすると、`Docker` サービスをインストールするように指示されるので、「今すぐインストール」をクリックし、指示に従ってインストールを完了します。 | ||
|
|
||
| 3. インストールが完了したら、アプリストアで「MediaGo」を見つけ、インストールをクリックし、ドメイン名などの基本情報を設定してインストールを完了します。 | ||
|
|
||
| ### ソフトウェアスクリーンショット | ||
|
|
||
|  | ||
|
|
||
| ### 重要な更新 | ||
|
|
||
| - Web端のdockerデプロイをサポート | ||
| - デスクトップ端のUIを更新 | ||
|
|
||
| ### 更新ログ | ||
|
|
||
| - デスクトップ端のUIを更新 | ||
| - Web端のdockerデプロイをサポート | ||
| - 新たにビデオ再生機能を追加、デスクトップとモバイル端両方で再生可能 | ||
| - Macでの画面表示ができない問題を修正 | ||
| - バッチダウンロードのインタラクションを最適化 | ||
| - Windowsのポータブル版（インストール不要）を追加 | ||
| - ダウンロードリストの最適化、ページ内の複数のビデオリソースを嗅ぎ取る機能を追加 | ||
| - 手動でお気に入りリストのインポートとエクスポートをサポート | ||
| - ホームページのダウンロードリストエクスポートをサポート | ||
| - 「新規ダウンロード」フォームのインタラクションロジックを最適化 | ||
| - UrlSchemeでアプリを開き、ダウンロードタスクを追加する機能をサポート | ||
| - バグの修正とユーザー体験の向上 | ||
|
|
||
| ## ソフトウェアスクリーンショット | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## 技術スタック | ||
|
|
||
| - react <https://react.dev/> | ||
| - electron <https://www.electronjs.org> | ||
| - koa <https://koajs.com> | ||
| - vite <https://cn.vitejs.dev> | ||
| - antd <https://ant.design> | ||
| - tailwindcss <https://tailwindcss.com> | ||
| - shadcn <https://ui.shadcn.com/> | ||
| - inversify <https://inversify.io> | ||
| - typeorm <https://typeorm.io> | ||
|
|
||
| ## 感謝 | ||
|
|
||
| - N_m2u8DL-CLI は <https://github.com/nilaoda/N_m3u8DL-CLI> から来ています | ||
| - N_m3u8DL-RE は <https://github.com/nilaoda/N_m3u8DL-RE> から来ています | ||
| - mediago は <https://github.com/caorushizi/hls-downloader> から来ています |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.