You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install.md
+60-36Lines changed: 60 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,33 +1,50 @@
1
-
# Installation
1
+
# Installation Instructions
2
2
3
-
1. Go to the official website to download, which will automatically select the corresponding version according to your operating system.
4
-
2. Go to GitHub to download, and you can choose the corresponding version to download by yourself.
3
+
## General Installation Instructions
5
4
6
-
## Windows
5
+
The following methods work on all platforms for quickly downloading Gopeed:
7
6
8
-
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.
7
+
1. Go to the [official website](https://gopeed.com) to download, which will automatically select the corresponding version according to your operating system.
8
+
2. Go to [GitHub](https://github.com/GopeedLab/gopeed/releases) to download, and you can choose the corresponding version to download by yourself.
9
+
10
+
## Platform-Specific Installation Guide
11
+
12
+
### Windows
13
+
14
+
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.
9
15
10
16
> The file name of the portable version is: Gopeed-v1.x.x-windows-amd64-portable.zip
11
17
12
-
### Firewall False Positive
18
+
In addition to downloading directly, you can also install or upgrade Gopeed through package managers:
19
+
20
+
-[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.
21
+
22
+
```powershell
23
+
scoop bucket add extras
24
+
scoop install extras/gopeed
25
+
```
26
+
27
+
-[Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget): Microsoft's official package manager, deeply integrated with the Windows operating system.
28
+
29
+
```powershell
30
+
winget install -e --id monkeyWie.Gopeed
31
+
```
32
+
33
+
#### Firewall False Positive
13
34
14
-
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.
35
+
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.
15
36
16
37
::: tip Note
17
38
18
-
**Secure Download**: Please ensure to download Gopeed from the [official website](https://gopeed.com) or [GitHub official repository](https://github.com/GopeedLab/gopeed/releases), avoid downloading from third-party channels to ensure software security.
39
+
**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.
19
40
20
41
**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.
21
42
22
43
:::
23
44
24
-
## Macos
25
-
26
-
The Macos version provides a .dmg file, which can be installed by double-clicking. The installation package supports two architectures: intel and apple silicon.
27
-
28
-
> Tips: If the macos open failed, please execute the `xattr -d com.apple.quarantine /Applications/Gopeed.app` command in the terminal
45
+
### Linux
29
46
30
-
## Linux
47
+
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:
31
48
32
49
- Flatpak
33
50
@@ -41,13 +58,17 @@ The Macos version provides a .dmg file, which can be installed by double-clickin
41
58
sudo snap install gopeed
42
59
```
43
60
44
-
Beyond that, there are also `.deb` and `.AppImage` installation packages, which can be downloaded and installed as needed.
61
+
### macOS
62
+
63
+
The macOS version provides a `.dmg` file, which can be installed by double-clicking. The installation package supports two architectures: `intel` and `apple silicon`.
64
+
65
+
> Tips: If the macOS open failed, please execute the `xattr -d com.apple.quarantine /Applications/Gopeed.app` command in the terminal
45
66
46
-
## Android
67
+
###Android
47
68
48
69
The Android version provides a `.apk` file, which can be downloaded and installed directly, and supports all CPU architectures.
49
70
50
-
## iOS
71
+
###iOS
51
72
52
73
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.
53
74
@@ -59,11 +80,11 @@ Currently, only the `.ipa` file is provided for the iOS platform, which needs to
59
80
>
60
81
> 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!
61
82
62
-
## Web
83
+
###Web
63
84
64
85
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.
65
86
66
-

87
+

67
88
68
89
Here is an example of how to use the Web version on the Windows platform, and the usage on other platforms is similar.
69
90
@@ -84,7 +105,7 @@ Here is an example of how to use the Web version on the Windows platform, and th
84
105
85
106
3. Open the browser and visit `http://localhost:9999`.
86
107
87
-
### Web Configuration
108
+
#### Web Configuration
88
109
89
110
The Web version supports configuration through command line parameters or configuration files. Command line parameters can be viewed through `./gopeed.exe -h`:
90
111
@@ -149,7 +170,7 @@ If you need to set the default download configuration when the server starts for
### BT Panel (for version 9.2.0 and above) Deployment Guide
218
+
219
+
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.
220
+
221
+
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.
222
+
223
+
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.
224
+
225
+
::: tip Note
226
+
227
+
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.
228
+
229
+
:::
230
+
231
+
4. After installation, enter the domain name or IP+port setin the previous step in the browser to access.
232
+
233
+
### Command Line
197
234
198
235
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.
199
236
@@ -214,7 +251,7 @@ Usage of gopeed:
214
251
Store directory. (default "C:\\Users\\levi")
215
252
```
216
253
217
-
### Command Line Usage Example
254
+
####Command Line Usage Example
218
255
219
256
Download an HTTP resource:
220
257
@@ -233,16 +270,3 @@ Download a magnet link:
233
270
```sh
234
271
gopeed magnet:?xt=urn:btih:xxxx
235
272
```
236
-
237
-
## BT Panel (for version 9.2.0 and above) Deployment Guide
238
-
239
-
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.
240
-
241
-
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.
242
-
243
-
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.
244
-
245
-
Note:
246
-
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.
247
-
248
-
4. After installation, enter the domain name or IP+port setin the previous step in the browser to access.
0 commit comments