From df2b3fd6622a9f6d66f9aab65d1f69531c8f707d Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Sun, 28 Jul 2024 15:12:11 -0500 Subject: [PATCH] Update docs --- README-zh.md | 21 +++++++++++++++++---- README.md | 21 +++++++++++++++++---- docs/clients-zh.md | 15 +++++++++++++-- docs/clients.md | 15 +++++++++++++-- 4 files changed, 60 insertions(+), 12 deletions(-) diff --git a/README-zh.md b/README-zh.md index 2ff4e0f..1b74cf3 100644 --- a/README-zh.md +++ b/README-zh.md @@ -85,7 +85,9 @@ https://gitlab.com/hwdsl2/openvpn-install/-/raw/master/openvpn-install.sh 高级：使用自定义选项自动安装。 -高级用户可以使用自定义选项自动安装 OpenVPN，方法是提供一个 Bash "here document" 作为安装脚本的输入。此方法还可用于在安装后提供输入以管理用户。 +高级用户可以使用自定义选项自动安装 OpenVPN，方法是在运行脚本时指定命令行参数。有关更多信息，请参见下一节，查看 OpenVPN 脚本的使用信息。 + +或者，你也可以提供一个 Bash "here document" 作为安装脚本的输入。此方法还可用于在安装后提供输入以管理用户。 首先，使用自定义选项以交互方式安装 OpenVPN，并写下你对脚本的所有输入值。 @@ -119,7 +121,7 @@ ANSWERS 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 @@ -128,7 +130,18 @@ Options: -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. +Install options (optional): + + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). + If not specified, the server's IPv4 address will be used. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients + +To customize options, you may also run this script without arguments. ``` @@ -155,7 +168,7 @@ To customize install options, run this script without arguments. - 改进了与 Setup IPsec VPN 的兼容性 - 改进了脚本的可靠性，用户输入和输出 -- 支持使用默认选项自动安装 +- 支持使用默认或自定义选项自动安装 - 支持使用域名作为服务器地址 - 增加了对 openSUSE Linux 的支持 - 增加了对 Amazon Linux 2 的支持 diff --git a/README.md b/README.md index 4d9164f..8295bbf 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,9 @@ If you are unable to download, open [openvpn-install.sh](openvpn-install.sh), th Advanced: Auto install using custom options. -Advanced users can auto install OpenVPN using custom options, by providing a Bash "here document" as input to the setup script. This method can also be used to provide input to manage users after install. +Advanced users can auto install OpenVPN using custom options, by specifying command-line options when running the script. For more details, see the next section "view usage information for the OpenVPN script". + +Alternatively, you may provide a Bash "here document" as input to the setup script. This method can also be used to provide input to manage users after install. First, install OpenVPN interactively using custom options, and write down all your inputs to the script. @@ -119,7 +121,7 @@ View usage information for the OpenVPN script. 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 @@ -128,7 +130,18 @@ Options: -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. +Install options (optional): + + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). + If not specified, the server's IPv4 address will be used. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients + +To customize options, you may also run this script without arguments. ``` @@ -155,7 +168,7 @@ List of enhancements over Nyr/openvpn-install. - Improved compatibility with Setup IPsec VPN - Improved script reliability, user input and output -- Supports auto install using default options +- Supports auto install using default or custom options - Supports using a DNS name as server address - Added support for openSUSE Linux - Added support for Amazon Linux 2 diff --git a/docs/clients-zh.md b/docs/clients-zh.md index 2d0ac0a..878f56c 100644 --- a/docs/clients-zh.md +++ b/docs/clients-zh.md @@ -19,7 +19,7 @@ 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 @@ -28,6 +28,17 @@ Options: -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. +Install options (optional): + + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). + If not specified, the server's IPv4 address will be used. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients + +To customize options, you may also run this script without arguments. ``` diff --git a/docs/clients.md b/docs/clients.md index a938121..64464d1 100644 --- a/docs/clients.md +++ b/docs/clients.md @@ -19,7 +19,7 @@ View usage information for the OpenVPN script. 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 @@ -28,6 +28,17 @@ Options: -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. +Install options (optional): + + --auto auto install OpenVPN using default or custom options + --serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). + If not specified, the server's IPv4 address will be used. + --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) + --port [number] port for OpenVPN (1-65535, default: 1194) + --clientname [client name] name for the first OpenVPN client (default: client) + --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) + --dns2 [DNS server IP] secondary DNS server for clients + +To customize options, you may also run this script without arguments. ```