Skip to content

Commit 1f861ab

Browse files
committed
Update docs
1 parent 618f32b commit 1f861ab

File tree

2 files changed

+50
-2
lines changed

2 files changed

+50
-2
lines changed

README-zh.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
wget -O wireguard.sh https://get.vpnsetup.net/wg
2929
```
3030

31+
\* 一个云服务器,虚拟专用服务器 (VPS) 或者专用服务器。
32+
3133
**选项 1:** 使用默认选项自动安装 WireGuard。
3234

3335
```bash
@@ -107,8 +109,29 @@ ANSWERS
107109

108110
**注:** 安装选项可能会在脚本的未来版本中发生变化。
109111
</details>
112+
<details>
113+
<summary>
114+
查看 WireGuard 脚本的使用信息。
115+
</summary>
110116

111-
\* 一个云服务器,虚拟专用服务器 (VPS) 或者专用服务器。
117+
```
118+
Usage: bash wireguard.sh [options]
119+
120+
Options:
121+
--auto auto install WireGuard using default options
122+
--addclient [client name] add a new client
123+
--dns1 [DNS server IP] primary DNS server for new client (optional, defaults to Google Public DNS)
124+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
125+
--listclients list the names of existing clients
126+
--removeclient [client name] remove an existing client
127+
--showclientqr [client name] show QR code for an existing client
128+
--uninstall remove WireGuard and delete all configuration
129+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
130+
-h, --help show this help message and exit
131+
132+
To customize install options, run this script without arguments.
133+
```
134+
</details>
112135

113136
## 下一步
114137

@@ -139,6 +162,7 @@ ANSWERS
139162
- 支持列出现有的 VPN 客户端
140163
- 支持显示客户端配置的二维码
141164
- 支持为 VPN 客户端自定义 DNS 服务器
165+
- 支持使用命令行参数管理 VPN 客户端
142166
- 优化 `sysctl` 设置以提高 VPN 性能
143167
- 使用 `sudo` 时改进了客户端配置文件的创建
144168

README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ First, download the script on your Linux server\*:
2828
wget -O wireguard.sh https://get.vpnsetup.net/wg
2929
```
3030

31+
\* A cloud server, virtual private server (VPS) or dedicated server.
32+
3133
**Option 1:** Auto install WireGuard using default options.
3234

3335
```bash
@@ -107,8 +109,29 @@ ANSWERS
107109

108110
**Note:** The install options may change in future versions of the script.
109111
</details>
112+
<details>
113+
<summary>
114+
View usage information for the WireGuard script.
115+
</summary>
110116

111-
\* A cloud server, virtual private server (VPS) or dedicated server.
117+
```
118+
Usage: bash wireguard.sh [options]
119+
120+
Options:
121+
--auto auto install WireGuard using default options
122+
--addclient [client name] add a new client
123+
--dns1 [DNS server IP] primary DNS server for new client (optional, defaults to Google Public DNS)
124+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
125+
--listclients list the names of existing clients
126+
--removeclient [client name] remove an existing client
127+
--showclientqr [client name] show QR code for an existing client
128+
--uninstall remove WireGuard and delete all configuration
129+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
130+
-h, --help show this help message and exit
131+
132+
To customize install options, run this script without arguments.
133+
```
134+
</details>
112135

113136
## Next steps
114137

@@ -139,6 +162,7 @@ List of enhancements over Nyr/wireguard-install.
139162
- Supports listing existing VPN clients
140163
- Supports showing QR code for a client
141164
- Supports custom DNS server(s) for VPN clients
165+
- Supports command-line options for managing VPN clients
142166
- Optimizes `sysctl` settings for improved VPN performance
143167
- Improved creation of client config files when using `sudo`
144168

0 commit comments

Comments
 (0)