Skip to content

Commit 52fea9d

Browse files
committed
Update docs
1 parent e058f5e commit 52fea9d

File tree

2 files changed

+46
-2
lines changed

2 files changed

+46
-2
lines changed

README-zh.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
wget -O openvpn.sh https://get.vpnsetup.net/ovpn
2929
```
3030

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

3335
```bash
@@ -108,8 +110,27 @@ ANSWERS
108110

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

112-
\* 一个云服务器,虚拟专用服务器 (VPS) 或者专用服务器。
118+
```
119+
Usage: bash openvpn.sh [options]
120+
121+
Options:
122+
--auto auto install OpenVPN using default options
123+
--addclient [client name] add a new client
124+
--exportclient [client name] export configuration for an existing client
125+
--listclients list the names of existing clients
126+
--revokeclient [client name] revoke an existing client
127+
--uninstall remove OpenVPN and delete all configuration
128+
-y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN
129+
-h, --help show this help message and exit
130+
131+
To customize install options, run this script without arguments.
132+
```
133+
</details>
113134

114135
## 下一步
115136

@@ -141,6 +162,7 @@ ANSWERS
141162
- 支持导出现有 VPN 客户端的配置
142163
- 支持列出现有的 VPN 客户端
143164
- 支持为 VPN 客户端自定义 DNS 服务器
165+
- 支持使用命令行参数管理 VPN 客户端
144166
- 优化 `sysctl` 设置以提高 VPN 性能
145167
- 使用 `sudo` 时改进了客户端配置文件的创建
146168

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ First, download the script on your Linux server\*:
2828
wget -O openvpn.sh https://get.vpnsetup.net/ovpn
2929
```
3030

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

3335
```bash
@@ -108,8 +110,27 @@ ANSWERS
108110

109111
**Note:** The install options may change in future versions of the script.
110112
</details>
113+
<details>
114+
<summary>
115+
View usage information for the OpenVPN script.
116+
</summary>
111117

112-
\* A cloud server, virtual private server (VPS) or dedicated server.
118+
```
119+
Usage: bash openvpn.sh [options]
120+
121+
Options:
122+
--auto auto install OpenVPN using default options
123+
--addclient [client name] add a new client
124+
--exportclient [client name] export configuration for an existing client
125+
--listclients list the names of existing clients
126+
--revokeclient [client name] revoke an existing client
127+
--uninstall remove OpenVPN and delete all configuration
128+
-y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN
129+
-h, --help show this help message and exit
130+
131+
To customize install options, run this script without arguments.
132+
```
133+
</details>
113134

114135
## Next steps
115136

@@ -141,6 +162,7 @@ List of enhancements over Nyr/openvpn-install.
141162
- Supports exporting configuration for an existing VPN client
142163
- Supports listing existing VPN clients
143164
- Supports custom DNS server(s) for VPN clients
165+
- Supports command-line options for managing VPN clients
144166
- Optimizes `sysctl` settings for improved VPN performance
145167
- Improved creation of client config files when using `sudo`
146168

0 commit comments

Comments
 (0)