Update docs

This commit is contained in:
hwdsl2
2024-07-28 15:12:11 -05:00
parent 283b79c898
commit df2b3fd662
4 changed files with 60 additions and 12 deletions

View File

@@ -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.
```
</details>

View File

@@ -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.
```
</details>