Skip to content

Commit 81e01b7

Browse files
authored
docs: update installation guide with platform-specific instructions and package manager support (#15)
1 parent fb726df commit 81e01b7

File tree

4 files changed

+229
-154
lines changed

4 files changed

+229
-154
lines changed

.vitepress/config.mjs

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ export default defineConfig({
9595
],
9696
},
9797
],
98+
outline: "deep",
9899
},
99100
},
100101
zh: {
@@ -157,6 +158,7 @@ export default defineConfig({
157158
],
158159
},
159160
],
161+
outline: "deep",
160162
},
161163
},
162164
"zh-TW": {
@@ -172,11 +174,11 @@ export default defineConfig({
172174
nav: [
173175
{
174176
text: "指南",
175-
link: "/zh-tw/index.md",
177+
link: "/zh-TW/index.md",
176178
},
177179
{
178180
text: "開發",
179-
link: "/zh-tw/dev.md",
181+
link: "/zh-TW/dev.md",
180182
},
181183
{
182184
text: "RESTFul API",
@@ -188,7 +190,7 @@ export default defineConfig({
188190
},
189191
{
190192
text: "捐贈",
191-
link: "/zh-tw/donate.md",
193+
link: "/zh-TW/donate.md",
192194
},
193195
],
194196
sidebar: [
@@ -197,11 +199,11 @@ export default defineConfig({
197199
items: [
198200
{
199201
text: "介紹",
200-
link: "/zh-tw/index.md",
202+
link: "/zh-TW/index.md",
201203
},
202204
{
203205
text: "安裝",
204-
link: "/zh-tw/install.md",
206+
link: "/zh-TW/install.md",
205207
},
206208
],
207209
},
@@ -210,15 +212,16 @@ export default defineConfig({
210212
items: [
211213
{
212214
text: "API 對接",
213-
link: "/zh-tw/dev-api.md",
215+
link: "/zh-TW/dev-api.md",
214216
},
215217
{
216218
text: "擴充開發",
217-
link: "/zh-tw/dev-extension.md",
219+
link: "/zh-TW/dev-extension.md",
218220
},
219221
],
220222
},
221223
],
224+
outline: "deep",
222225
},
223226
},
224227
},

docs/install.md

Lines changed: 60 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,50 @@
1-
# Installation
1+
# Installation Instructions
22

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
54

6-
## Windows
5+
The following methods work on all platforms for quickly downloading Gopeed:
76

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

1016
> The file name of the portable version is: Gopeed-v1.x.x-windows-amd64-portable.zip
1117
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
1334

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

1637
::: tip Note
1738

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

2041
**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.
2142

2243
:::
2344

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
2946

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:
3148

3249
- Flatpak
3350

@@ -41,13 +58,17 @@ The Macos version provides a .dmg file, which can be installed by double-clickin
4158
sudo snap install gopeed
4259
```
4360

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
4566
46-
## Android
67+
### Android
4768

4869
The Android version provides a `.apk` file, which can be downloaded and installed directly, and supports all CPU architectures.
4970

50-
## iOS
71+
### iOS
5172

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

@@ -59,11 +80,11 @@ Currently, only the `.ipa` file is provided for the iOS platform, which needs to
5980
>
6081
> 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!
6182
62-
## Web
83+
### Web
6384

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

66-
![](/images/guide/install/web.png)
87+
![web](/images/guide/install/web.png)
6788

6889
Here is an example of how to use the Web version on the Windows platform, and the usage on other platforms is similar.
6990

@@ -84,7 +105,7 @@ Here is an example of how to use the Web version on the Windows platform, and th
84105
85106
3. Open the browser and visit `http://localhost:9999`.
86107
87-
### Web Configuration
108+
#### Web Configuration
88109
89110
The Web version supports configuration through command line parameters or configuration files. Command line parameters can be viewed through `./gopeed.exe -h`:
90111
@@ -149,7 +170,7 @@ If you need to set the default download configuration when the server starts for
149170
}
150171
```
151172
152-
## Docker
173+
### Docker
153174
154175
One line of command:
155176
@@ -193,7 +214,23 @@ docker run --name gopeed -d -p 9999:9999 \
193214
liwei2633/gopeed
194215
```
195216
196-
## Command Line
217+
### 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 set in the previous step in the browser to access.
232+
233+
### Command Line
197234
198235
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.
199236
@@ -214,7 +251,7 @@ Usage of gopeed:
214251
Store directory. (default "C:\\Users\\levi")
215252
```
216253

217-
### Command Line Usage Example
254+
#### Command Line Usage Example
218255

219256
Download an HTTP resource:
220257

@@ -233,16 +270,3 @@ Download a magnet link:
233270
```sh
234271
gopeed magnet:?xt=urn:btih:xxxx
235272
```
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 set in the previous step in the browser to access.

0 commit comments

Comments
 (0)