Skip to content

Commit 706483d

Browse files
committed
Update docs
1 parent bb9080c commit 706483d

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

docs/clients-zh.md

+24
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,27 @@
99
要管理 WireGuard VPN 客户端,请再次运行安装脚本:`sudo bash wireguard.sh`
1010

1111
阅读 [:book: VPN book](https://ko-fi.com/post/Support-this-project-and-get-access-to-supporter-o-X8X5FVFZC) 以了解配置和管理 WireGuard VPN 客户端的分步说明。
12+
13+
<details>
14+
<summary>
15+
查看 WireGuard 脚本的使用信息。
16+
</summary>
17+
18+
```
19+
Usage: bash wireguard.sh [options]
20+
21+
Options:
22+
--auto auto install WireGuard using default options
23+
--addclient [client name] add a new client
24+
--dns1 [DNS server IP] primary DNS server for new client (optional, defaults to Google Public DNS)
25+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
26+
--listclients list the names of existing clients
27+
--removeclient [client name] remove an existing client
28+
--showclientqr [client name] show QR code for an existing client
29+
--uninstall remove WireGuard and delete all configuration
30+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
31+
-h, --help show this help message and exit
32+
33+
To customize install options, run this script without arguments.
34+
```
35+
</details>

docs/clients.md

+24
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,27 @@ To add a VPN connection, open the WireGuard App on your mobile device, tap the "
99
To manage WireGuard VPN clients, run the install script again: `sudo bash wireguard.sh`.
1010

1111
Read [:book: VPN book](https://ko-fi.com/post/Support-this-project-and-get-access-to-supporter-o-O5O7FVF8J) to learn step-by-step instructions to configure and manage WireGuard VPN clients.
12+
13+
<details>
14+
<summary>
15+
View usage information for the WireGuard script.
16+
</summary>
17+
18+
```
19+
Usage: bash wireguard.sh [options]
20+
21+
Options:
22+
--auto auto install WireGuard using default options
23+
--addclient [client name] add a new client
24+
--dns1 [DNS server IP] primary DNS server for new client (optional, defaults to Google Public DNS)
25+
--dns2 [DNS server IP] secondary DNS server for new client (optional)
26+
--listclients list the names of existing clients
27+
--removeclient [client name] remove an existing client
28+
--showclientqr [client name] show QR code for an existing client
29+
--uninstall remove WireGuard and delete all configuration
30+
-y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
31+
-h, --help show this help message and exit
32+
33+
To customize install options, run this script without arguments.
34+
```
35+
</details>

0 commit comments

Comments
 (0)