From bfb3609f1c4fd0640b0733098d2c7a46b3c86622 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 2 Mar 2026 01:36:15 +0000 Subject: [PATCH 1/2] Initial plan From 9748afe62a654aec9d15f38f8aa01259ccca322d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 2 Mar 2026 01:42:22 +0000 Subject: [PATCH 2/2] Replace VitePress docs with Next.js redirect app Co-authored-by: monkeyWie <13160176+monkeyWie@users.noreply.github.com> --- .github/workflows/ci.yaml | 3 - .vitepress/config.mjs | 251 -- app/layout.tsx | 11 + app/page.tsx | 3 + build.sh | 12 - docs/dev-api.md | 61 - docs/dev-extension.md | 365 -- docs/dev.md | 11 - docs/donate.md | 17 - docs/index.md | 57 - docs/install.md | 272 -- docs/public/favicon.ico | Bin 4286 -> 0 bytes .../images/dev/extension/demo-settings.gif | Bin 344369 -> 0 bytes docs/public/images/dev/extension/demo.gif | Bin 130532 -> 0 bytes docs/public/images/dev/extension/dev-mode.gif | Bin 40609 -> 0 bytes docs/public/images/dev/set-port.png | Bin 9343 -> 0 bytes docs/public/images/dev/set-token.png | Bin 9661 -> 0 bytes docs/public/images/donate/alipay.jpg | Bin 83440 -> 0 bytes docs/public/images/donate/wechatpay.jpg | Bin 78273 -> 0 bytes docs/public/images/guide/install/web.png | Bin 49912 -> 0 bytes docs/public/images/guide/showcase.png | Bin 29451 -> 0 bytes docs/public/images/logo.png | Bin 30084 -> 0 bytes docs/public/js/firebase-analytics_9.23.0.js | 3 - docs/public/js/firebase-app_9.23.0.js | 2522 ----------- docs/public/site/openapi/index.html | 16 - docs/public/site/openapi/rapidoc-min.js | 3895 ----------------- docs/public/site/reference/.gitkeep | 0 docs/zh-TW/dev-api.md | 61 - docs/zh-TW/dev-extension.md | 346 -- docs/zh-TW/dev.md | 11 - docs/zh-TW/donate.md | 17 - docs/zh-TW/index.md | 57 - docs/zh-TW/install.md | 272 -- docs/zh/dev-api.md | 61 - docs/zh/dev-extension.md | 346 -- docs/zh/dev.md | 11 - docs/zh/donate.md | 17 - docs/zh/index.md | 57 - docs/zh/install.md | 272 -- middleware.ts | 29 + next-env.d.ts | 6 + next.config.ts | 5 + package-lock.json | 953 ++++ package.json | 29 +- pnpm-lock.yaml | 1143 ----- tsconfig.json | 27 + vercel.json | 24 - 47 files changed, 1046 insertions(+), 10197 deletions(-) delete mode 100644 .vitepress/config.mjs create mode 100644 app/layout.tsx create mode 100644 app/page.tsx delete mode 100644 build.sh delete mode 100644 docs/dev-api.md delete mode 100644 docs/dev-extension.md delete mode 100644 docs/dev.md delete mode 100644 docs/donate.md delete mode 100644 docs/index.md delete mode 100644 docs/install.md delete mode 100644 docs/public/favicon.ico delete mode 100644 docs/public/images/dev/extension/demo-settings.gif delete mode 100644 docs/public/images/dev/extension/demo.gif delete mode 100644 docs/public/images/dev/extension/dev-mode.gif delete mode 100644 docs/public/images/dev/set-port.png delete mode 100644 docs/public/images/dev/set-token.png delete mode 100644 docs/public/images/donate/alipay.jpg delete mode 100644 docs/public/images/donate/wechatpay.jpg delete mode 100644 docs/public/images/guide/install/web.png delete mode 100644 docs/public/images/guide/showcase.png delete mode 100644 docs/public/images/logo.png delete mode 100644 docs/public/js/firebase-analytics_9.23.0.js delete mode 100644 docs/public/js/firebase-app_9.23.0.js delete mode 100644 docs/public/site/openapi/index.html delete mode 100644 docs/public/site/openapi/rapidoc-min.js delete mode 100644 docs/public/site/reference/.gitkeep delete mode 100644 docs/zh-TW/dev-api.md delete mode 100644 docs/zh-TW/dev-extension.md delete mode 100644 docs/zh-TW/dev.md delete mode 100644 docs/zh-TW/donate.md delete mode 100644 docs/zh-TW/index.md delete mode 100644 docs/zh-TW/install.md delete mode 100644 docs/zh/dev-api.md delete mode 100644 docs/zh/dev-extension.md delete mode 100644 docs/zh/dev.md delete mode 100644 docs/zh/donate.md delete mode 100644 docs/zh/index.md delete mode 100644 docs/zh/install.md create mode 100644 middleware.ts create mode 100644 next-env.d.ts create mode 100644 next.config.ts create mode 100644 package-lock.json delete mode 100644 pnpm-lock.yaml create mode 100644 tsconfig.json delete mode 100644 vercel.json diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 541f595..a555364 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -12,9 +12,6 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: pnpm/action-setup@v3 - with: - version: 9 - name: Install Vercel CLI run: npm install --global vercel@canary - name: Pull Vercel Environment Information diff --git a/.vitepress/config.mjs b/.vitepress/config.mjs deleted file mode 100644 index 412b061..0000000 --- a/.vitepress/config.mjs +++ /dev/null @@ -1,251 +0,0 @@ -import { defineConfig } from "vitepress"; -import markdownItTaskLists from "markdown-it-task-lists"; - -// https://vitepress.dev/reference/site-config -export default defineConfig({ - lang: "en-US", - title: "Gopeed Docs", - description: "Gopeed docs website", - srcDir: "docs", - sitemap: { - hostname: "https://docs.gopeed.com", - }, - appearance: "dark", - head: [ - [ - "script", - { type: "module", defer: true }, - ` - import { initializeApp } from "/js/firebase-app_9.23.0.js"; - import { getAnalytics } from "/js/firebase-analytics_9.23.0.js"; - - const firebaseConfig = { - apiKey: "AIzaSyBG1Jyk-3J5lgSXAmmjyQjCnxTLQS5e-VU", - authDomain: "gopeed-4de76.firebaseapp.com", - projectId: "gopeed-4de76", - storageBucket: "gopeed-4de76.appspot.com", - messagingSenderId: "742279468136", - appId: "1:742279468136:web:f21afb9ea70cdca2c897dd", - measurementId: "G-6F2570B28S" - }; - - const app = initializeApp(firebaseConfig); - getAnalytics(app); - `, - ], - ], - locales: { - root: { - label: "English", - lang: "en", - title: "Gopeed Docs", - description: "Gopeed docs website", - themeConfig: { - socialLinks: [ - { icon: "github", link: "https://github.com/GopeedLab/gopeed" }, - { icon: "discord", link: "https://discord.gg/ZUJqJrwCGB" }, - ], - nav: [ - { - text: "Guide", - link: "/index.md", - }, - { - text: "Development", - link: "/dev.md", - }, - { - text: "RESTFul API", - link: "https://docs.gopeed.com/site/openapi/index.html", - }, - { - text: "SDK Reference", - link: "https://docs.gopeed.com/site/reference/index.html", - }, - { - text: "Donate", - link: "/donate.md", - }, - ], - sidebar: [ - { - text: "Guide", - items: [ - { - text: "Introduction", - link: "/index.md", - }, - { - text: "Install", - link: "/install.md", - }, - ], - }, - { - text: "Development", - items: [ - { - text: "API Integration", - link: "/dev-api.md", - }, - { - text: "Extension Development", - link: "/dev-extension.md", - }, - ], - }, - ], - outline: "deep", - }, - }, - zh: { - label: "简体中文", - lang: "zh-CN", - title: "Gopeed 文档", - description: "Gopeed 文档网站", - themeConfig: { - socialLinks: [ - { icon: "github", link: "https://github.com/GopeedLab/gopeed" }, - { icon: "discord", link: "https://discord.gg/ZUJqJrwCGB" }, - ], - nav: [ - { - text: "指南", - link: "/zh/index.md", - }, - { - text: "开发", - link: "/zh/dev.md", - }, - { - text: "RESTFul API", - link: "https://docs.gopeed.com/site/openapi/index.html", - }, - { - text: "SDK Reference", - link: "https://docs.gopeed.com/site/reference/index.html", - }, - { - text: "捐赠", - link: "/donate.md", - }, - ], - sidebar: [ - { - text: "指南", - items: [ - { - text: "介绍", - link: "/zh/index.md", - }, - { - text: "安装", - link: "/zh/install.md", - }, - ], - }, - { - text: "开发", - items: [ - { - text: "API 对接", - link: "/zh/dev-api.md", - }, - { - text: "扩展开发", - link: "/zh/dev-extension.md", - }, - ], - }, - ], - outline: "deep", - }, - }, - "zh-TW": { - label: "正體中文", - lang: "zh-TW", - title: "Gopeed 文件", - description: "Gopeed 文件網站", - themeConfig: { - socialLinks: [ - { icon: "github", link: "https://github.com/GopeedLab/gopeed" }, - { icon: "discord", link: "https://discord.gg/ZUJqJrwCGB" }, - ], - nav: [ - { - text: "指南", - link: "/zh-TW/index.md", - }, - { - text: "開發", - link: "/zh-TW/dev.md", - }, - { - text: "RESTFul API", - link: "https://docs.gopeed.com/site/openapi/index.html", - }, - { - text: "SDK Reference", - link: "https://docs.gopeed.com/site/reference/index.html", - }, - { - text: "捐贈", - link: "/zh-TW/donate.md", - }, - ], - sidebar: [ - { - text: "指南", - items: [ - { - text: "介紹", - link: "/zh-TW/index.md", - }, - { - text: "安裝", - link: "/zh-TW/install.md", - }, - ], - }, - { - text: "開發", - items: [ - { - text: "API 對接", - link: "/zh-TW/dev-api.md", - }, - { - text: "擴充開發", - link: "/zh-TW/dev-extension.md", - }, - ], - }, - ], - outline: "deep", - }, - }, - }, - themeConfig: { - logo: "/images/logo.png", - logoLink: "https://gopeed.com", - editLink: { - pattern: "https://github.com/GopeedLab/docs/edit/main/docs/:path", - text: "Edit this page on GitHub", - }, - search: { - provider: "local", - }, - lastUpdated: { - text: "Updated at", - formatOptions: { - dateStyle: "full", - timeStyle: "medium", - }, - }, - }, - markdown: { - config: (md) => { - md.use(markdownItTaskLists); - }, - }, -}); diff --git a/app/layout.tsx b/app/layout.tsx new file mode 100644 index 0000000..15cf066 --- /dev/null +++ b/app/layout.tsx @@ -0,0 +1,11 @@ +export default function RootLayout({ + children, +}: { + children: React.ReactNode; +}) { + return ( + +
{children} + + ); +} diff --git a/app/page.tsx b/app/page.tsx new file mode 100644 index 0000000..67e0859 --- /dev/null +++ b/app/page.tsx @@ -0,0 +1,3 @@ +export default function Page() { + return null; +} diff --git a/build.sh b/build.sh deleted file mode 100644 index 9877362..0000000 --- a/build.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/bash - -set -e - -pnpm run docs:build - -# Install gopeed-js -git clone --depth=1 https://github.com/GopeedLab/gopeed-js .gopeed-js -cd .gopeed-js -rm -rf .git -pnpm install -pnpm run build diff --git a/docs/dev-api.md b/docs/dev-api.md deleted file mode 100644 index 620665a..0000000 --- a/docs/dev-api.md +++ /dev/null @@ -1,61 +0,0 @@ -# API Integration - -Gopeed provides an HTTP API interface for external use, allowing for download management through the API. - -## Enable API - -First, you need to set the communication protocol to TCP. Go to **Settings -> Advanced -> Communication Protocol** and set the communication protocol to TCP. Then, set the IP and port as shown in the figure below: - - - -::: info -You can set any `port`, but be careful not to use ports that are already in use or reserved by the system, as this may cause access failures. -::: - -After that, you can access the API through `http://127.0.0.1:9999`. For security reasons, it is recommended to set a token. Go to **Settings -> Advanced -> API Token** and set a token as shown in the figure below: - - - -> Note: The above settings take effect after a restart. - -## Using JS SDK - -Gopeed provides an official js library, which needs to be installed first by running `npm install @gopeed/rest`: - -``` -npm install @gopeed/rest -``` - -Then you can use it happily, for example: - -```js -import { Client } from "@gopeed/rest"; - -(async function () { - // Create a client - const client = new Client(); - // Create a task - const res = await client.createTask({ - req: { - url: "https://example.com/file.zip", - }, - }); -})(); -``` - -More usages please refer to [documentation](https://docs.gopeed.com/site/reference/classes/_gopeed_rest.Client.html). - -## Using Python SDK - -A Python SDK provided by community user [@tick97115115](https://github.com/tick97115115). - -```bash -pip install gospeed_api -``` - -- Github:https://github.com/tick97115115/gospeed_api -- Example:https://github.com/tick97115115/gospeed_api/blob/main/tests/test_index.py - -## Using HTTP API - -Of course, you can also directly call the API through HTTP requests. For details, please refer to the [API documentation](https://docs.gopeed.com/site/openapi/index.html). diff --git a/docs/dev-extension.md b/docs/dev-extension.md deleted file mode 100644 index de02376..0000000 --- a/docs/dev-extension.md +++ /dev/null @@ -1,365 +0,0 @@ -# Extension Development - -Gopeed supports extension development using `JavaScript`. Extensions can enhance Gopeed's functionality, such as downloading videos or music from a website. You can quickly learn more about it through the [official examples](https://github.com/GopeedLab/gopeed-extension-samples/blob/main/README_zh-CN.md). - -Gopeed extensions are based on `git` to achieve decentralized extension management. As long as the extension source code is hosted in a remote git repository, it can be installed and updated through Gopeed. Therefore, whether it is `github`, `gitee`, `gitlab`, or other git hosting platforms, they can all be used as extension repositories. - -## Quick Start - -### Using scaffolding - -Gopeed provides a scaffolding to help you quickly create an extension development project template: - -```sh -npx create-gopeed-ext@latest -``` - -In the creation process, you will see the following prompts: - -```sh -√ Project name (gopeed-extension-demo) ... -√ Choose a template » Webpack - -Success! Created gopeed-extension-demo at D:\code\study\js\gopeed-extension-demo -Inside that directory, you can run several commands: - - git init - Initialize git repository - - npm install - Install dependencies - - npm run dev - Compiles and hot-reloads for development. - - npm run build - Compiles and minifies for production. - -We suggest that you begin by typing: - - cd gopeed-extension-demo - -Happy coding! -``` - -### Manual setup - -If you are not familiar with the `node.js` peripheral tools, you can also manually create a project, the file structure is as follows: - -```sh -├── index.js -├── manifest.json -``` - -## Local debugging - -After the project is built, you need to do local debugging. You can install the local extension project into Gopeed for debugging. The specific steps are as follows: - -1. Enable the `Gopeed` developer mode, click the install button `5 times in a row` on the extension page to enable the developer mode. - - - -2. Click the button to select the extension directory in the directory selector to install. - -3. If you use the `webpack` mode in the scaffolding, you can start automatic compilation through `npm run dev`. - -4. Create a task to see the extension take effect. - - - -It can be seen that the example extension created through the scaffolding can parse an `example/index.html` file when creating a task using the `https://github.com/hello` link. - -> Note: Developer mode is only valid on the desktop platform. - -## Development explanation - -In the previous section, we were able to create a basic extension and debug it locally, but what is happening under the hood? - -First, let's take a look at the `manifest.json` file, which is the manifest file of the extension. It describes the information of the extension. Each extension project must contain a `manifest.json` file in the root directory. The sample file in this section is as follows: - -```json -{ - "name": "gopeed-extention-demo", - "author": "", - "title": "gopeed extention demo title", - "description": "gopeed extention demo description", - "icon": "", - "version": "1.0.0", - "homepage": "", - "repository": { - "url": "" - }, - "scripts": [ - { - "event": "onResolve", - "match": { - "urls": ["*://github.com/*"] - }, - "entry": "dist/index.js" - } - ], - "settings": [] -} -``` - -Next, let's introduce the meaning of each field one by one: - -- `name` and `author`: Gopeed will use `
|
| [Click Me](https://paypal.me/monkeyWie) |
-
-### Cryptocurrency
-
-- **BTC**: 35jYkPN8bgkh7AWjt3B1VgMQHqtGYcvF6p
-- **ETH:** 0x928a7fd2398c941Ac6713704e606Fa414595e3A0
-- **Matic:** 0x928a7fd2398c941Ac6713704e606Fa414595e3A0
-- **BNB:** 0x928a7fd2398c941Ac6713704e606Fa414595e3A0
-- **USDT(ERC20)**: 0x928a7fd2398c941Ac6713704e606Fa414595e3A0
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index 0dd13aa..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,57 +0,0 @@
-# Introduction
-
-Gopeed (full name Go Speed) is a high-speed downloader developed by `Golang` + `Flutter`, which supports (HTTP, BitTorrent, Magnet) protocol download, and supports all platforms, including:
-
-- [x] **Windows**
-- [x] **Macos**
-- [x] **Linux**
-- [x] **Android**
-- [x] **iOS**
-- [x] **Web**
-- [x] **Docker**
-- [x] **Command Tool**
-
-## Features
-
-As a modern downloader, Gopeed has many features, here is a brief introduction.
-
-### Basic
-
-- Support HTTP & HTTPS
-- Support BitTorrent & Magnet
-- Seed, DHT, PEX, uTP, Webtorrent, Upnp
-- Update tracker list every day automatically
-- Internationalization
-- Dark mode
-
-### Advanced
-
-In addition to basic download functions, there are many advanced features that make Gopeed more playable.
-
-- **Open HTTP API**
-
- Through the RESTFul API, you can easily interact with Gopeed, for example, you can control Gopeed's download, pause, delete, etc. through the API.
-
-- **Decentralized extension**
-
- You can write extensions through `JavaScript` to enhance Gopeed's download capabilities, such as downloading videos from a website, or downloading music from a website, etc.
-
-## Why not...?
-
-Here is a comparison with popular downloaders on the market, which shows the advantages of Gopeed intuitively.
-
-| Function | Gopeed | Motrix | IDM |
-| ---------------------- | ------ | --------------------------- | ----------------- |
-| HTTP | ✔️ | ✔️ | ✔️ |
-| BitTorrent | ✔️ | ✔️ | ❌ |
-| Magnet | ✔️ | ✔️ | ❌ |
-| Cross-platform support | ✔️ | ❌ (only desktop platforms) | ❌ (only Windows) |
-| Free | ✔️ | ✔️ | ❌ |
-| Open source | ✔️ | ✔️ | ❌ |
-| Non-Electron | ✔️ | ❌ | ✔️ |
-| Open API | ✔️ | ✔️ | ❌ |
-| Extension support | ✔️ | ❌ | ❌ |
-
-Of course, Gopeed may also have many shortcomings, but we will continue to improve it.
-
-Moreover, Gopeed is open source, you can propose your ideas anytime, anywhere, or directly contribute code to make Gopeed better.
diff --git a/docs/install.md b/docs/install.md
deleted file mode 100644
index eb30ddb..0000000
--- a/docs/install.md
+++ /dev/null
@@ -1,272 +0,0 @@
-# Installation Instructions
-
-## General Installation Instructions
-
-The following methods work on all platforms for quickly downloading Gopeed:
-
-1. Go to the [official website](https://gopeed.com) to download, which will automatically select the corresponding version according to your operating system.
-2. Go to [GitHub](https://github.com/GopeedLab/gopeed/releases) to download, and you can choose the corresponding version to download by yourself.
-
-## Platform-Specific Installation Guide
-
-### Windows
-
-Windows has two distributions, one is a portable version, and the other is an installer version. The portable version does not need to be installed, just unzip it and run it. The installer version needs to be installed, and the installation process is the same as other software. You can choose according to your own preferences.
-
-> The file name of the portable version is: Gopeed-v1.x.x-windows-amd64-portable.zip
-
-In addition to downloading directly, you can also install or upgrade Gopeed through package managers:
-
-- [Scoop](https://github.com/ScoopInstaller/Scoop): A community-maintained command-line package manager for Windows. It’s lightweight and flexible, doesn’t require administrator privileges to install, and makes managing and updating software easy.
-
- ```powershell
- scoop bucket add extras
- scoop install extras/gopeed
- ```
-
-- [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget): Microsoft's official package manager, deeply integrated with the Windows operating system.
-
- ```powershell
- winget install -e --id monkeyWie.Gopeed
- ```
-
-#### Firewall False Positive
-
-In the Windows system, some antivirus software may falsely report Gopeed's two core components: `host.exe` for browser extension communication and `updater.exe` for application updates. To ensure that the browser extension can properly intercept download tasks and the application can update automatically, please add the `Gopeed installation directory` to the whitelist of your firewall or antivirus software.
-
-::: tip Note
-
-**Safe Download**: Be sure to download Gopeed using the methods described in this document—either from the [official website](https://gopeed.com), the [official GitHub repository](https://github.com/GopeedLab/gopeed/releases), or through Scoop or Winget. Avoid using third-party sources to ensure the security of the software.
-
-**About False Positives**: This may be related to the characteristics of applications compiled with Go language, and there is currently no good solution. In the future, we will consider migrating the components to Rust development to improve this issue.
-
-:::
-
-### Linux
-
-In the Linux system, we provide both `.deb` and `.AppImage` packages for installation, so you can choose whichever works best for you. In addition, you can also install quickly using the following commands:
-
-- Flatpak
-
- ```sh
- flatpak install flathub com.gopeed.Gopeed
- ```
-
-- Snap
-
- ```sh
- sudo snap install gopeed
- ```
-
-### macOS
-
-The macOS version provides a `.dmg` file, which can be installed by double-clicking. The installation package supports two architectures: `intel` and `apple silicon`.
-
-> Tips: If the macOS open failed, please execute the `xattr -d com.apple.quarantine /Applications/Gopeed.app` command in the terminal
-
-### Android
-
-The Android version provides a `.apk` file, which can be downloaded and installed directly, and supports all CPU architectures.
-
-### iOS
-
-Currently, only the `.ipa` file is provided for the iOS platform, which needs to be signed and installed by itself. It is recommended to use [TrollStore](https://github.com/opa334/TrollStore) for installation.
-
-> Why is it not listed on the App Store?
->
-> Because of Apple's review mechanism, BitTorrent protocol-related apps are not allowed to be listed.
->
-> Why is it not listed on TestFlight?
->
-> Because there is no money! The project is purely for love and power generation. If enough sponsorship can be obtained, it will be listed on TestFlight immediately. So please support us more. Open source is not easy. Thank you!
-
-### Web
-
-If you need a remote download service, you can consider using the Web version. Gopeed provides Web versions for various platforms. You can download them according to your system and CPU architecture.
-
-
-
-Here is an example of how to use the Web version on the Windows platform, and the usage on other platforms is similar.
-
-1. Download the Web version, and after decompression, you will get a folder. Put it where you want.
-2. Open the terminal in the root directory of the folder and execute `./gopeed.exe`. If it runs successfully, you will see the following output:
-
- ```bash
-
- _______ ______ .______ _______ _______ _______
- / _____| / __ \ | _ \ | ____|| ____|| \
- | | __ | | | | | |_) | | |__ | |__ | .--. |
- | | |_ | | | | | | ___/ | __| | __| | | | |
- | |__| | | `--' | | | | |____ | |____ | '--' |
- \______| \______/ | _| |_______||_______||_______/
-
- Server start success on http://[::]:9999
- ```
-
-3. Open the browser and visit `http://localhost:9999`.
-
-#### Web Configuration
-
-The Web version supports configuration through command line parameters or configuration files. Command line parameters can be viewed through `./gopeed.exe -h`:
-
-```sh
-$ ./gopeed.exe -h
-Usage of C:\Users\levi\Downloads\gopeed-web-v1.3.13-windows-amd64\gopeed.exe:
- -A string
- Bind Address (default "0.0.0.0")
- -P int
- Bind Port (default 9999)
- -T string
- API token, that can only be used when basic authentication is enabled.
- -c string
- Config file path (default "./config.json")
- -d string
- Storage directory
- -p string
- HTTP Basic Auth Password
- -u string
- HTTP Basic Auth Username (default "gopeed")
-```
-
-It also supports configuration through configuration files. Create a `config.json` file in the root directory with the following content:
-
-```json
-{
- "address": "", // Bind address (default "0.0.0.0")
- "port": 0, // Bind port (default 9999)
- "username": "", // HTTP Basic Auth Username (default "gopeed")
- "password": "", // HTTP Basic Auth Password, used with username. If both are empty, authentication is disabled
- "apiToken": "", // HTTP API token, when using API token without authentication enabled, the web UI is inaccessible and can only be accessed through the API
- "storageDir": "", // Storage directory
- "whiteDownloadDirs": ["/root/downloads", "/root/dir/*", "/root/dir?abc"] // Download directory whitelist, when this option is configured, all tasks downloaded to non-whitelisted folders will fail, support wildcard, rules refer to https://pkg.go.dev/path/filepath#Match
-}
-```
-
-It also supports configuration through environment variables, with the rule `GOPEED_ConfigKey`, for example:
-
-```sh
-export GOPEED_ADDRESS="0.0.0.0"
-export GOPEED_PORT="9999"
-export GOPEED_USERNAME="gopeed"
-export GOPEED_PASSWORD="xxx"
-export GOPEED_APITOKEN=""
-export GOPEED_STORAGEDIR=""
-export GOPEED_WHITEDOWNLOADDIRS="/root/downloads,/root/dir/*,/root/dir?abc"
-```
-
-> Note: If you are deploying on a public IP, please ensure to enable identity authentication, otherwise there will be security risks.
-
-#### Default Download Configuration
-
-If you need to set the default download configuration when the server starts for the first time, you can add the `downloadConfig` field in `config.json`. For configuration details, please refer to [DownloaderStoreConfig](https://pkg.go.dev/github.com/GopeedLab/gopeed/pkg/base#DownloaderStoreConfig). Here is an example:
-
-```json
-{
- "address": "127.0.0.1",
- "port": 9999,
- "downloadConfig": {
- "downloadDir": "d:/test" // Set the default download directory
- }
-}
-```
-
-### Docker
-
-One line of command:
-
-```sh
-docker run --name gopeed -d -p 9999:9999 liwei2633/gopeed
-```
-
-Mount the download directory
-
-```sh
-docker run --name gopeed -d -p 9999:9999 \
- -v /path/to/download:/app/Downloads \
- liwei2633/gopeed
-```
-
-Mount the data directory
-
-```sh
-docker run --name gopeed -d -p 9999:9999 \
- -v /path/to/download:/app/Downloads \
- -v /path/to/storage:/app/storage liwei2633/gopeed
-```
-
-Specify container group ID and user ID
-
-```sh
-docker run --name gopeed -d -p 9999:9999 \
- -e PGID=100 \
- -e PUID=1000 \
- liwei2633/gopeed
-```
-
-If you need to enable identity authentication, you can pass environment variable parameters (refer to the previous section `Web Configuration`):
-
-```sh
-docker run --name gopeed -d -p 9999:9999 \
- -e GOPEED_USERNAME="admin" \
- -e GOPEED_PASSWORD="123" \
- -v /path/to/download:/app/Downloads \
- -v /path/to/storage:/app/storage \
- liwei2633/gopeed
-```
-
-### BT Panel (for version 9.2.0 and above) Deployment Guide
-
-1. Install BT Panel, go to [BT Panel Official Website](https://www.bt.cn/new/download.html), select the official version script to download and install.
-
-2. After installation, log in to the BT Panel, click Docker in the left navigation bar. First, it will prompt to install Docker service, click Install Now and complete the installation according to the prompts.
-
-3. After completing the installation, find Gopeed in the App Store, click Install, configure domain name, port and other basic information to complete the installation.
-
- ::: tip Note
-
- Domain name is optional. If a domain name is filled in, it will be managed through [Website] --> [Reverse Proxy]. After filling in the domain name, you don't need to check [Allow External Access], otherwise you need to check it to access through the port.
-
- :::
-
-4. After installation, enter the domain name or IP+port set in the previous step in the browser to access.
-
-### Command Line
-
-The command line version depends on the `Golang` environment. If you do not have the `Golang` environment installed, you can refer to [here](https://golang.org/doc/install) for installation.
-
-Installation command:
-
-```sh
-go install github.com/GopeedLab/gopeed/cmd/gopeed@latest
-```
-
-After the installation is complete, you can use the `gopeed` command to download. You can view the specific usage method through `gopeed -h`:
-
-```sh
-$ gopeed -h
-Usage of gopeed:
- -C int
- Concurrent connections. (default 16)
- -D string
- Store directory. (default "C:\\Users\\levi")
-```
-
-#### Command Line Usage Example
-
-Download an HTTP resource:
-
-```sh
-gopeed https://example.com/file.zip
-```
-
-Download a torrent file:
-
-```sh
-gopeed D:/Downloads/file.torrent
-```
-
-Download a magnet link:
-
-```sh
-gopeed magnet:?xt=urn:btih:xxxx
-```
diff --git a/docs/public/favicon.ico b/docs/public/favicon.ico
deleted file mode 100644
index 877571685bc95c667d6183ae4ebd6a0a7f7ea6ef..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 4286
zcmc&&>r<3f7(b04nh9sRS>F=AbonppTbDneY1FI_1fvKRf|r3IF_20#Y^EC1G0`S$
zEXNd#%#4}=R&cp2i$J2lf*AJ&7FbwzpMJl?dzhEqciAw?b$*=lp6Bv=&U2pg?7J%U
z5dNj4DE?JvA5-dSrPK=mmeflC*YyXoCz2MixRChoj=DFMg(oq-ysdUqQDxux%7{cf
zBGN;IBVo^l-m?{yQ3s%|woA<5tYPdiZUlA#wcBeqPabVM7#R%?gLe66X!b8T;ynw*F j&lb0&W2Igz;ijb{d5_@hHBOOx;SF;(EUVY`CDMyV{jcS%PmcDc>
zuX*b5N;Ilt9H-_b>Iq^+p%4!~tUCouB0
zbv2O|5NvY;&@pdA2Mqll;l#DKCH*+YJR4Re89?vN{Vd>T!l>Gh^
zCTTF?HgSoBLwCk;wmz=rlp_S^=k9*f9D@@I0}J-z6ef*vE$!+_`_KzdZJpe6^Ct5a
zbM8c8Q#T>h{(R&NFLF#f5C=(AMZ0h0n(+p?QxY4mzND}&Pm=yxRsMYQMFU_9^^DR4
zWdbU|0(6yEcXd}qfER7dy`U@-{YVYlaqoQ2^~OX-*E8n-2(>kFGg6Z
w0Q{(&1Br%8YFZ7xHEe<(V$mI&8m8<7e )z+}+*X-K}w##@#KrySrO(m-Ol9`OlnrXX-swXXf+lkGuBX
zUDdVMzJB+$*1Z;4)r+b88E4|Jew|n8wFBHY4mRlp(WagRlzF$5lfvC^F48xZTdxxo
zeYbmZiy~`7*
BBM31pgW-7ixuSnPKJIx__6Eto#(h9O0YA)Fy4`czdHeF%)b?JU@Eb1
z0B6iVn~b7@yPJ{~#D4&iLtmOmG%cc`Om}Q#pcK>|;9tscx|iI`JnSx|1A0E2l|;k9
zyC3A};=3Q^)5A*1Wkv23(iWs54;AwGtEkV%rv?+37MQS{9P8$UGnN(U-?^F_M3)hp
z=WRGXpZu&D0hxKHTN|EKNWqt!Rx|D_g1Hi5HIl3Q(9?BF0p