Installation

Go to the official website to download, which will automatically select the corresponding version according to your operating system.
Go to GitHub to download, and you can choose the corresponding version to download by yourself.

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.

The file name of the portable version is: Gopeed-v1.x.x-windows-amd64-portable.zip

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

Linux

Flatpak

flatpak install flathub com.gopeed.Gopeed

flatpak install flathub com.gopeed.Gopeed

Snap

sudo snap install gopeed

sudo snap install gopeed

Beyond that, there are also .deb and .AppImage installation packages, which can be downloaded and installed as needed.

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

Download the Web version, and after decompression, you will get a folder. Put it where you want.

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


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

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

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:

$ ./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")

$ ./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
  "apiToken": "", // HTTP API token, it must be configured when using HTTP API in the case of enabling basic authentication
  "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
}

{
  "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
  "apiToken": "", // HTTP API token, it must be configured when using HTTP API in the case of enabling basic authentication
  "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
}

Note: If you are deploying on a public IP, it is recommended 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. Here is an example:

json

{
  "address": "127.0.0.1",
  "port": 9999,
  "downloadConfig": {
    "downloadDir": "d:/test" // Set the default download directory
  }
}

{
  "address": "127.0.0.1",
  "port": 9999,
  "downloadConfig": {
    "downloadDir": "d:/test" // Set the default download directory
  }
}

Docker

One line of command:

docker run --name gopeed -d -p 9999:9999 liwei2633/gopeed

docker run --name gopeed -d -p 9999:9999 liwei2633/gopeed

Mount the download directory

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

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

Mount the data directory

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

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

Specify user ID and group ID

docker run --name gopeed -e PGID=100 -e PUID=1000 liwei2633/gopeed

docker run --name gopeed -e PGID=100 -e PUID=1000 liwei2633/gopeed

If you need to enable identity authentication, you can pass command line parameters (refer to the previous section Web Configuration):

docker run --name gopeed -d -p 9999:9999 -v /path/to/download:/app/Downloads -v /path/to/storage:/app/storage liwei2633/gopeed -u admin -p 123456

docker run --name gopeed -d -p 9999:9999 -v /path/to/download:/app/Downloads -v /path/to/storage:/app/storage liwei2633/gopeed -u admin -p 123456

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 for installation.

Installation command:

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

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:

$ 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")

Command Line Usage Example

Download an HTTP resource:

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

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

Download a torrent file:

gopeed D:/Downloads/file.torrent

gopeed D:/Downloads/file.torrent

Download a magnet link:

gopeed magnet:?xt=urn:btih:xxxx

gopeed magnet:?xt=urn:btih:xxxx

Installation ​

Windows ​

Macos ​

Linux ​

Android ​

iOS ​

Web ​

Web Configuration ​

Default Download Configuration ​

Docker ​

Command Line ​

Command Line Usage Example ​