Update docs

This commit is contained in:
hwdsl2
2024-08-04 21:38:23 -05:00
parent 4b302ebc52
commit f171a21cdd
4 changed files with 56 additions and 60 deletions

View File

@@ -122,24 +122,23 @@ Usage: bash openvpn.sh [options]
Options: Options:
--addclient [client name] add a new client --addclient [client name] add a new client
--exportclient [client name] export configuration for an existing client --exportclient [client name] export configuration for an existing client
--listclients list the names of existing clients --listclients list the names of existing clients
--revokeclient [client name] revoke an existing client --revokeclient [client name] revoke an existing client
--uninstall remove OpenVPN and delete all configuration --uninstall remove OpenVPN and delete all configuration
-y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN
-h, --help show this help message and exit -h, --help show this help message and exit
Install options (optional): Install options (optional):
--auto auto install OpenVPN using default or custom options --auto auto install OpenVPN using default or custom options
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
If not specified, the server's IPv4 address will be used. --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP)
--proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) --port [number] port for OpenVPN (1-65535, default: 1194)
--port [number] port for OpenVPN (1-65535, default: 1194) --clientname [client name] name for the first OpenVPN client (default: client)
--clientname [client name] name for the first OpenVPN client (default: client) --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS)
--dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) --dns2 [DNS server IP] secondary DNS server for clients
--dns2 [DNS server IP] secondary DNS server for clients
To customize options, you may also run this script without arguments. To customize options, you may also run this script without arguments.
``` ```

View File

@@ -122,24 +122,23 @@ Usage: bash openvpn.sh [options]
Options: Options:
--addclient [client name] add a new client --addclient [client name] add a new client
--exportclient [client name] export configuration for an existing client --exportclient [client name] export configuration for an existing client
--listclients list the names of existing clients --listclients list the names of existing clients
--revokeclient [client name] revoke an existing client --revokeclient [client name] revoke an existing client
--uninstall remove OpenVPN and delete all configuration --uninstall remove OpenVPN and delete all configuration
-y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN
-h, --help show this help message and exit -h, --help show this help message and exit
Install options (optional): Install options (optional):
--auto auto install OpenVPN using default or custom options --auto auto install OpenVPN using default or custom options
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
If not specified, the server's IPv4 address will be used. --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP)
--proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) --port [number] port for OpenVPN (1-65535, default: 1194)
--port [number] port for OpenVPN (1-65535, default: 1194) --clientname [client name] name for the first OpenVPN client (default: client)
--clientname [client name] name for the first OpenVPN client (default: client) --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS)
--dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) --dns2 [DNS server IP] secondary DNS server for clients
--dns2 [DNS server IP] secondary DNS server for clients
To customize options, you may also run this script without arguments. To customize options, you may also run this script without arguments.
``` ```

View File

@@ -20,24 +20,23 @@ Usage: bash openvpn.sh [options]
Options: Options:
--addclient [client name] add a new client --addclient [client name] add a new client
--exportclient [client name] export configuration for an existing client --exportclient [client name] export configuration for an existing client
--listclients list the names of existing clients --listclients list the names of existing clients
--revokeclient [client name] revoke an existing client --revokeclient [client name] revoke an existing client
--uninstall remove OpenVPN and delete all configuration --uninstall remove OpenVPN and delete all configuration
-y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN
-h, --help show this help message and exit -h, --help show this help message and exit
Install options (optional): Install options (optional):
--auto auto install OpenVPN using default or custom options --auto auto install OpenVPN using default or custom options
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
If not specified, the server's IPv4 address will be used. --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP)
--proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) --port [number] port for OpenVPN (1-65535, default: 1194)
--port [number] port for OpenVPN (1-65535, default: 1194) --clientname [client name] name for the first OpenVPN client (default: client)
--clientname [client name] name for the first OpenVPN client (default: client) --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS)
--dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) --dns2 [DNS server IP] secondary DNS server for clients
--dns2 [DNS server IP] secondary DNS server for clients
To customize options, you may also run this script without arguments. To customize options, you may also run this script without arguments.
``` ```

View File

@@ -20,24 +20,23 @@ Usage: bash openvpn.sh [options]
Options: Options:
--addclient [client name] add a new client --addclient [client name] add a new client
--exportclient [client name] export configuration for an existing client --exportclient [client name] export configuration for an existing client
--listclients list the names of existing clients --listclients list the names of existing clients
--revokeclient [client name] revoke an existing client --revokeclient [client name] revoke an existing client
--uninstall remove OpenVPN and delete all configuration --uninstall remove OpenVPN and delete all configuration
-y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN -y, --yes assume "yes" as answer to prompts when revoking a client or removing OpenVPN
-h, --help show this help message and exit -h, --help show this help message and exit
Install options (optional): Install options (optional):
--auto auto install OpenVPN using default or custom options --auto auto install OpenVPN using default or custom options
--serveraddr [DNS name] server address, must be a fully qualified domain name (FQDN). --serveraddr [DNS name or IP] server address, must be a fully qualified domain name (FQDN) or an IPv4 address.
If not specified, the server's IPv4 address will be used. --proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP)
--proto [TCP or UDP] protocol for OpenVPN (TCP or UDP, default: UDP) --port [number] port for OpenVPN (1-65535, default: 1194)
--port [number] port for OpenVPN (1-65535, default: 1194) --clientname [client name] name for the first OpenVPN client (default: client)
--clientname [client name] name for the first OpenVPN client (default: client) --dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS)
--dns1 [DNS server IP] primary DNS server for clients (default: Google Public DNS) --dns2 [DNS server IP] secondary DNS server for clients
--dns2 [DNS server IP] secondary DNS server for clients
To customize options, you may also run this script without arguments. To customize options, you may also run this script without arguments.
``` ```