diff --git a/README-zh.md b/README-zh.md index 1c0de17..2ff4e0f 100644 --- a/README-zh.md +++ b/README-zh.md @@ -28,6 +28,8 @@ wget -O openvpn.sh https://get.vpnsetup.net/ovpn ``` +\* 一个云服务器,虚拟专用服务器 (VPS) 或者专用服务器。 + **选项 1:** 使用默认选项自动安装 OpenVPN。 ```bash @@ -108,8 +110,27 @@ ANSWERS **注:** 安装选项可能会在脚本的未来版本中发生变化。 +
+ +查看 OpenVPN 脚本的使用信息。 + -\* 一个云服务器,虚拟专用服务器 (VPS) 或者专用服务器。 +``` +Usage: bash openvpn.sh [options] + +Options: + --auto auto install OpenVPN using default options + --addclient [client name] add a new client + --exportclient [client name] export configuration for an existing client + --listclients list the names of existing clients + --revokeclient [client name] revoke an existing client + --uninstall remove OpenVPN and delete all configuration + -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN + -h, --help show this help message and exit + +To customize install options, run this script without arguments. +``` +
## 下一步 @@ -141,6 +162,7 @@ ANSWERS - 支持导出现有 VPN 客户端的配置 - 支持列出现有的 VPN 客户端 - 支持为 VPN 客户端自定义 DNS 服务器 +- 支持使用命令行参数管理 VPN 客户端 - 优化 `sysctl` 设置以提高 VPN 性能 - 使用 `sudo` 时改进了客户端配置文件的创建 diff --git a/README.md b/README.md index fee7549..4d9164f 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ First, download the script on your Linux server\*: wget -O openvpn.sh https://get.vpnsetup.net/ovpn ``` +\* A cloud server, virtual private server (VPS) or dedicated server. + **Option 1:** Auto install OpenVPN using default options. ```bash @@ -108,8 +110,27 @@ ANSWERS **Note:** The install options may change in future versions of the script. +
+ +View usage information for the OpenVPN script. + -\* A cloud server, virtual private server (VPS) or dedicated server. +``` +Usage: bash openvpn.sh [options] + +Options: + --auto auto install OpenVPN using default options + --addclient [client name] add a new client + --exportclient [client name] export configuration for an existing client + --listclients list the names of existing clients + --revokeclient [client name] revoke an existing client + --uninstall remove OpenVPN and delete all configuration + -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN + -h, --help show this help message and exit + +To customize install options, run this script without arguments. +``` +
## Next steps @@ -141,6 +162,7 @@ List of enhancements over Nyr/openvpn-install. - Supports exporting configuration for an existing VPN client - Supports listing existing VPN clients - Supports custom DNS server(s) for VPN clients +- Supports command-line options for managing VPN clients - Optimizes `sysctl` settings for improved VPN performance - Improved creation of client config files when using `sudo`