Gopeed 文档

简体中文

English

简体中文

English

Appearance

安装 ​

  1. 前往 官网 下载，会根据你的操作系统自动选择对应的版本进行下载。
  2. 前往 GitHub 下载，可以自行选择对应的版本进行下载。

Windows 安装 ​

Windows 分为两个版本，一个是安装包版本还有一个是免安装版本，大家可以根据自己的喜好进行选择。

免安装版本文件名为：Gopeed-v1.x.x-windows-amd64-portable.zip

Macos 安装 ​

Macos 版本提供了.dmg文件，双击即可安装，安装包支持intel和apple silicon两种架构。

Linux 安装 ​

Linux 目前只提供了.deb安装包，如果你有其它 Linux 发行版的需求，可以去提 issue 寻求帮助，或者自行编译。

Android 安装 ​

Android 版本提供了.apk文件，可以直接下载安装，支持所有的 CPU 架构。

iOS 安装 ​

目前 iOS 平台只提供了.ipa文件，需要自行签名安装，推荐使用TrollStore(巨魔商店)进行安装。

为什么没有上架到 App Store？

因为苹果的审核机制，不允许 BitTorrent 协议相关 App 上架。

为什么没有上架到 TestFlight？

因为没钱！项目纯为爱发电，如果能得到足够的赞助，会立刻上架到 TestFlight，所以请多多支持，开源不易，感谢！

Web 安装 ​

如果你需要一个远程下载服务，那么可以考虑使用 Web 版本，Gopeed 提供了各个平台的 Web 版本，你可以根据自己的系统和 cpu 架构进行下载。

这里我以 Windows 平台为例，介绍一下如何使用 Web 版本，其它平台的使用方法类似。

  1. 下载 Web 版本，解压后会得到一个文件夹，将其放到你想要的位置。

  2. 在文件夹根目录打开终端，执行./gopeed.exe，如果运行成功会看到如下输出：

    bash
    
   _______   ______   .______    _______  _______  _______
 /  _____| /  __  \  |   _  \  |   ____||   ____||       \
 |  |  __  |  |  |  | |  |_)  | |  |__   |  |__   |  .--.  |
 |  | |_ | |  |  |  | |   ___/  |   __|  |   __|  |  |  |  |
 |  |__| | |  `--'  | |  |      |  |____ |  |____ |  '--'  |
 \______|  \______/  | _|      |_______||_______||_______/

 Server start success on http://[::]:9999
    
   _______   ______   .______    _______  _______  _______
 /  _____| /  __  \  |   _  \  |   ____||   ____||       \
 |  |  __  |  |  |  | |  |_)  | |  |__   |  |__   |  .--.  |
 |  | |_ | |  |  |  | |   ___/  |   __|  |   __|  |  |  |  |
 |  |__| | |  `--'  | |  |      |  |____ |  |____ |  '--'  |
 \______|  \______/  | _|      |_______||_______||_______/

 Server start success on http://[::]:9999

  3. 打开浏览器，访问http://localhost:9999 即可。

Web 配置 ​

Web 版支持命令行参数或者配置文件进行配置，命令行参数可以通过./gopeed.exe -h查看：

sh
$ ./gopeed.exe -h
Usage of C:\Users\liwei\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")
  -p string
        HTTP Basic Auth Password
  -u string
        HTTP Basic Auth Username (default "gopeed")
$ ./gopeed.exe -h
Usage of C:\Users\liwei\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")
  -p string
        HTTP Basic Auth Password
  -u string
        HTTP Basic Auth Username (default "gopeed")

同时也支持通过配置文件进行配置，在根目录下创建config.json文件，内容如下：

json
{
  "address": "", // 绑定的IP地址（默认：0.0.0.0)
  "port": 0, // 绑定的端口（默认：9999)
  "username": "", // 服务身份认证用户名，为空时不启用身份认证
  "password": "", // 服务身份认证密码（默认：gopeed)
  "token": "" // HTTP API token，只有在启用身份认证时才有效
}
{
  "address": "", // 绑定的IP地址（默认：0.0.0.0)
  "port": 0, // 绑定的端口（默认：9999)
  "username": "", // 服务身份认证用户名，为空时不启用身份认证
  "password": "", // 服务身份认证密码（默认：gopeed)
  "token": "" // HTTP API token，只有在启用身份认证时才有效
}

注：如果你是在公网 ip 上进行部署，建议启用身份认证，否则会有安全风险。

Docker 安装 ​

直接一行命令即可运行：

sh
docker run --name gopeed -d -p 9999:9999 -v /path/to/download:/root/Downloads liwei2633/gopeed
docker run --name gopeed -d -p 9999:9999 -v /path/to/download:/root/Downloads liwei2633/gopeed

如果需要启用身份认证，可以传递命令行参数：

sh
docker run --name gopeed -d -p 9999:9999 -v /path/to/download:/root/Downloads liwei2633/gopeed -u admin -p gopeed
docker run --name gopeed -d -p 9999:9999 -v /path/to/download:/root/Downloads liwei2633/gopeed -u admin -p gopeed

注：记得把 /path/to/download 替换为你自己的宿主机下载目录。

命令行安装 ​

命令行版本需要依赖Golang环境，如果你没有安装Golang环境，可以参考这里进行安装。

安装命令：

sh
go install github.com/GopeedLab/gopeed/cmd/gopeed@latest
go install github.com/GopeedLab/gopeed/cmd/gopeed@latest

安装完成就可以使用gopeed命令进行下载了，具体使用方法可以通过gopeed -h查看：

sh
$ gopeed -h
Usage of gopeed:
  -C int
        Concurrent connections. (default 16)
  -D string
        Store directory. (default "C:\\Users\\levi")
$ gopeed -h
Usage of gopeed:
  -C int
        Concurrent connections. (default 16)
  -D string
        Store directory. (default "C:\\Users\\levi")

命令行使用示例 ​

下载一个 HTTP 资源：

sh
gopeed https://example.com/file.zip
gopeed https://example.com/file.zip

下载一个种子文件：

sh
gopeed D:/Downloads/file.torrent
gopeed D:/Downloads/file.torrent

下载一个磁力链接：

sh
gopeed magnet:?xt=urn:btih:xxxx
gopeed magnet:?xt=urn:btih:xxxx