Skip to content

Commit f66cb76

Browse files
parhelia512parhelia512
authored
Merge pull request #3 from VedaChen/chinese
Add documentation for installation and configuration
2 parents 6a41667 + 8ce5b4a commit f66cb76

16 files changed

Lines changed: 333 additions & 20 deletions

File tree

‎config.toml‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,24 @@ base_url = "https://throneproj.github.io"
33
title = "Throne"
44
description = "Throne"
55

6-
build_search_index = true
6+
77
default_language = "en"
88
generate_feeds = true
99
generate_sitemap = true
1010

1111
[markdown]
12-
highlight_code = true
1312
bottom_footnotes = true
14-
highlight_theme = "ayu-mirage"
1513

1614
[languages.fa]
1715
generate_feeds = true
1816

1917
[languages.ru]
2018
generate_feeds = true
21-
build_search_index = true
19+
2220

2321
[languages.zh]
2422
generate_feeds = true
25-
build_search_index = true
23+
2624

2725
[extra]
2826
logo_text = "Throne"
@@ -37,3 +35,4 @@ nav = [
3735
{ name = "Documents", url = "/introduction", type = "url", icon = "fa-solid fa-book" },
3836
{ name = "GitHub", url = "https://github.com/throneproj/Throne", type = "url", icon = "fa-brands fa-github" },
3937
]
38+
highlighting = true

‎content/get_started/_index.zh.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Get Started"
2+
title = "开始使用"
33
description = "Get started with Throne"
44
weight = 2
55
sort_by = "weight"

‎content/get_started/advanced/index.fa.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "Advanced Configuration"
3+
description = "Advanced configuration options for Throne."
4+
weight = 3
5+
sort_by = "weight"
6+
7+
[extra]
8+
+++
9+
10+
TODO

‎content/get_started/advanced/index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "Advanced Configuration"
3+
description = "Advanced configuration options for Throne."
4+
weight = 3
5+
sort_by = "weight"
6+
7+
[extra]
8+
+++
9+
10+
Advanced configuration content coming soon.

‎content/get_started/advanced/index.ru.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "Advanced Configuration"
3+
description = "Advanced configuration options for Throne."
4+
weight = 3
5+
sort_by = "weight"
6+
7+
[extra]
8+
+++
9+
10+
TODO

‎content/get_started/advanced/index.zh.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "进阶配置"
3+
description = "Throne 进阶配置选项。"
4+
weight = 3
5+
sort_by = "weight"
6+
7+
[extra]
8+
+++
9+
10+
TODO

‎content/get_started/configuration/index.zh.md‎

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,78 @@
11
+++
2-
title = "Configuration"
3-
description = "Learn how to configure Throne."
2+
title = "配置"
3+
description = "学习如何配置 Throne。"
44
weight = 2
55
sort_by = "weight"
66

77
[extra]
88
+++
99

10-
TODO
10+
Throne 支持两种代理模式：
11+
12+
## 系统代理 (System Proxy)
13+
14+
通过修改系统代理设置，使整个系统的流量通过代理转发。适用于浏览器等应用程序。
15+
16+
## TUN 模式
17+
18+
创建虚拟网卡，实现全局代理。所有应用的网络流量都会经过代理，包括不支持代理设置的软件。
19+
20+
> 推荐使用 TUN 模式，代理更加彻底。
21+
22+
> 注意：开启 TUN 模式时请关闭系统代理，两者不能同时启用。
23+
24+
## 导入订阅
25+
26+
### 方法一：直接粘贴
27+
28+
在主界面直接按 `Ctrl+V` 粘贴订阅链接。
29+
30+
> 导入后分组名称默认为 `Default`，右键点击分组可选择 `更新订阅`（快捷键 `Ctrl+U`）。
31+
32+
### 方法二：通过设置导入
33+
34+
1. 进入 `设置` → `分组`
35+
2. 新建分组，输入名称
36+
3. 将类型修改为 `订阅`
37+
4. 在 URL 中粘贴订阅链接
38+
5. 点击确定保存
39+
6. 右键点击该分组，选择 `刷新列表`
40+
41+
![导入订阅](/images/configuration/1.png)
42+
43+
![刷新列表](/images/configuration/2.png)
44+
45+
如果链接正确，即可解析到代理列表。
46+
47+
![代理列表](/images/configuration/3.png)
48+
49+
## 测试延迟
50+
51+
1. 全选列表，右键点击
52+
2. 选择 `URL 测试选定项目`（快捷键 `Ctrl+Shift+S`）
53+
54+
![URL测试](/images/configuration/4.png)
55+
56+
3. 选择延迟最低的节点，右键点击选择 `启用` 或直接按 `Enter`
57+
58+
## 启用代理
59+
### 配置规则
60+
无论是 TUN 模式还是系统代理，都需要配置路由规则（以中国大陆为例）：
61+
62+
1. 点击 `路由` → `下载配置档位`
63+
2. 选择 `Bypass China` + `Bypass China Blocked`
64+
3. 点击 `路由` → `路由设置` → `路由`
65+
4. 删除默认的路由规则，只保留刚才下载的两个规则
66+
67+
![路由设置](/images/configuration/5.png)
68+
69+
### 启动代理
70+
71+
> 推荐使用 TUN 模式。
72+
73+
1. 先启动一个节点
74+
2. 然后选择一种代理模式（TUN 或系统代理）
75+
76+
> 注意：如果使用 TUN 模式，更新订阅时请先关闭 TUN，更新完成后再重新启用。
77+
78+
![启动代理](/images/configuration/6.png)

‎content/get_started/installation/index.md‎

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,107 @@ sort_by = "weight"
77
[extra]
88
+++
99

10-
TODO
10+
Throne supports Windows, Linux, and macOS. Choose the appropriate installation method for your platform.
11+
12+
## System Requirements
13+
14+
| Platform | Minimum Version | Architecture |
15+
|----------|-----------------|--------------|
16+
| Windows | Windows 7 SP1 | x64, ARM64 |
17+
| Linux | GLIBC 2.31+ | x64, ARM64 |
18+
| macOS | macOS 10.15+ | x64, ARM64 |
19+
20+
## Windows
21+
22+
Download the latest release from [GitHub Releases](https://github.com/throneproj/Throne/releases/latest):
23+
24+
- `Throne-x.x.x-windows-arm64.zip` - for ARM64 devices
25+
- `Throne-x.x.x-windows-*.zip` - for x64 devices
26+
27+
Extract the ZIP file and run `Throne.exe`.
28+
29+
## Linux
30+
31+
### Debian/Ubuntu (.deb)
32+
33+
Download the `.deb` package from [GitHub Releases](https://github.com/throneproj/Throne/releases/latest):
34+
35+
```bash
36+
# For systems with Qt libraries installed
37+
sudo dpkg -i Throne-x.x.x-debian-amd64.deb
38+
39+
# For legacy systems (includes bundled Qt libraries)
40+
sudo dpkg -i Throne-x.x.x-debian-amd64.deb
41+
```
42+
43+
The `-system-qt` version does not bundle Qt libraries and relies on system-installed ones. If the GUI fails to load, try the system-qt version.
44+
45+
### RPM-based Distributions
46+
47+
For Fedora, RHEL, and openSUSE, use the [RPM repository](https://parhelia512.github.io/).
48+
49+
### Arch Linux (AUR)
50+
51+
For Arch Linux and Arch-based distributions, install from the [AUR](https://aur.archlinux.org/packages/throne):
52+
53+
```bash
54+
# Using yay or paru
55+
yay -S throne-git
56+
57+
# Or build from source
58+
git clone --recursive https://github.com/throneproj/Throne.git
59+
cd Throne
60+
mkdir build
61+
cd build
62+
cmake ..
63+
make -j$(nproc)
64+
```
65+
66+
### Portable (ZIP)
67+
68+
Download the ZIP package:
69+
70+
```bash
71+
unzip Throne-x.x.x-linux-*.zip
72+
./Throne
73+
```
74+
75+
### Post-Installation (Linux)
76+
77+
To use TUN mode (system proxy), set the SUID bit on the Throne binary:
78+
79+
```bash
80+
sudo chmod +s /usr/bin/Throne
81+
```
82+
83+
## macOS
84+
85+
Download the appropriate version from [GitHub Releases](https://github.com/throneproj/Throne/releases/latest):
86+
87+
- `Throne-x.x.x-macos-arm64.zip` - for Apple Silicon (M1/M2/M3)
88+
- `Throne-x.x.x-macos-amd64.zip` - for Intel Macs
89+
- `Throne-x.x.x-macoslegacy-amd64.zip` - for older macOS versions
90+
91+
### After Downloading
92+
93+
Due to Apple's strict security policy, you must remove the quarantine attribute:
94+
95+
```bash
96+
xattr -d com.apple.quarantine /path/to/Throne.app
97+
```
98+
99+
To enable built-in privilege escalation, grant `Terminal` Full Disk Access in `System Preferences` → `Security & Privacy` → `Privacy` → `Full Disk Access`.
100+
101+
## Updating
102+
103+
Throne has a built-in update function. You can also download new releases manually from the [Releases page](https://github.com/throneproj/Throne/releases).
104+
105+
## Troubleshooting
106+
107+
### Antivirus Detection
108+
109+
Some antivirus software may flag Throne as malware because its update functionality downloads, removes, and replaces files—similar to ransomware behavior. Additionally, the `System DNS` feature modifies system DNS settings, which some antivirus applications consider dangerous.
110+
111+
## Next Steps
112+
113+
After installation, proceed to [Configuration](/get_started/configuration/) to set up your proxy profiles.

‎content/get_started/installation/index.zh.md‎

Lines changed: 106 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,113 @@
11
+++
2-
title = "Installation"
3-
description = "How to install Throne and get started."
2+
title = "安装"
3+
description = "如何安装 Throne 并开始使用。"
44
weight = 1
55
sort_by = "weight"
66

77
[extra]
88
+++
99

10-
TODO
10+
Throne 支持 Windows、Linux 和 macOS。请根据您的平台选择合适的安装方式。
11+
12+
## 系统要求
13+
14+
| 平台 | 最低版本 | 架构 |
15+
|---------|----------------|--------------|
16+
| Windows | Windows 7 SP1 | x64, ARM64 |
17+
| Linux | GLIBC 2.31+ | x64, ARM64 |
18+
| macOS | macOS 10.15+ | x64, ARM64 |
19+
20+
## Windows
21+
22+
从 [GitHub Releases](https://github.com/throneproj/Throne/releases/latest) 下载最新版本：
23+
24+
- `Throne-x.x.x-windows-arm64.zip` - ARM64 设备
25+
- `Throne-x.x.x-windows-*.zip` - x64 设备
26+
27+
解压 ZIP 文件并运行 `Throne.exe`。
28+
29+
## Linux
30+
31+
### Debian/Ubuntu (.deb)
32+
33+
从 [GitHub Releases](https://github.com/throneproj/Throne/releases/latest) 下载 `.deb` 包：
34+
35+
```bash
36+
# 系统已安装 Qt 库
37+
sudo dpkg -i Throne-x.x.x-debian-amd64.deb
38+
39+
# 系统未安装 Qt 库
40+
sudo dpkg -i Throne-x.x.x-debian-amd64.deb
41+
```
42+
43+
`-system-qt` 版本不包含 Qt 库，依赖系统已安装的 Qt 库。如果 GUI 无法加载，请尝试 system-qt 版本。
44+
45+
### RPM 发行版
46+
47+
对于 Fedora、RHEL 和 openSUSE，请使用 [RPM 仓库](https://parhelia512.github.io/)。
48+
49+
### Arch Linux (AUR)
50+
51+
对于 Arch Linux 及基于 Arch 的发行版，请从 [AUR](https://aur.archlinux.org/packages/throne) 安装：
52+
53+
```bash
54+
# 使用 yay 或 paru
55+
yay -S throne-git
56+
57+
# 或从源代码构建
58+
git clone --recursive https://github.com/throneproj/Throne.git
59+
cd Throne
60+
mkdir build
61+
cd build
62+
cmake ..
63+
make -j$(nproc)
64+
```
65+
66+
### 便携版 (ZIP)
67+
68+
下载 ZIP 包：
69+
70+
```bash
71+
unzip Throne-x.x.x-linux-*.zip
72+
./Throne
73+
```
74+
75+
### 安装后配置 (Linux)
76+
77+
要使用 TUN 模式（系统代理），请设置 SUID 位：
78+
79+
```bash
80+
sudo chmod +s /usr/bin/Throne
81+
```
82+
83+
## macOS
84+
85+
从 [GitHub Releases](https://github.com/throneproj/Throne/releases/latest) 下载对应版本：
86+
87+
- `Throne-x.x.x-macos-arm64.zip` - Apple Silicon (M1/M2/M3)
88+
- `Throne-x.x.x-macos-amd64.zip` - Intel Mac
89+
- `Throne-x.x.x-macoslegacy-amd64.zip` - 旧版 macOS
90+
91+
### 下载后配置
92+
93+
由于 Apple 的严格安全策略，您必须移除隔离属性：
94+
95+
```bash
96+
xattr -d com.apple.quarantine /path/to/Throne.app
97+
```
98+
99+
要启用内置提权功能，请在 `系统偏好设置` → `安全性与隐私` → `隐私` → `完全磁盘访问权限` 中授予 `终端` 完全磁盘访问权限。
100+
101+
## 更新
102+
103+
Throne 具有内置更新功能。您也可以手动从 [Releases 页面](https://github.com/throneproj/Throne/releases) 下载新版本。
104+
105+
## 故障排除
106+
107+
### 杀毒软件误报
108+
109+
某些杀毒软件可能会将 Throne 标记为恶意软件，因为其更新功能会下载、删除和替换文件——这与勒索软件行为类似。请自行解决。
110+
111+
## 下一步
112+
113+
安装完成后，请前往 [配置](/get_started/configuration/) 设置您的代理配置。

0 commit comments

Comments
 (0)