openvpn-install/docs/clients.md

English | 中文

Configure OpenVPN Clients

OpenVPN clients are available for Windows, macOS, iOS, Android and Linux. macOS users can also use Tunnelblick.

To add a VPN connection, first securely transfer the generated .ovpn file to your device, then open the OpenVPN App and import the VPN profile.

To manage OpenVPN clients, run the install script again: sudo bash openvpn.sh.

Read 📖 VPN book to learn step-by-step instructions to configure and manage OpenVPN clients.

View usage information for the OpenVPN script.

Usage: bash openvpn.sh [options]

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

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.