Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 2.18 KB

clients.md

File metadata and controls

44 lines (32 loc) · 2.18 KB

English | 中文

Configure WireGuard VPN Clients

WireGuard VPN clients are available for Windows, macOS, iOS and Android.

To add a VPN connection, open the WireGuard App on your mobile device, tap the "Add" button, then scan the generated QR code in the script output. For Windows and macOS, first securely transfer the generated .conf file to your computer, then open WireGuard and import the file.

To manage WireGuard VPN clients, run the install script again: sudo bash wireguard.sh.

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

View usage information for the WireGuard script.
Usage: bash wireguard.sh [options]

Options:

  --addclient [client name]      add a new client
  --dns1 [DNS server IP]         primary DNS server for new client (optional, default: Google Public DNS)
  --dns2 [DNS server IP]         secondary DNS server for new client (optional)
  --listclients                  list the names of existing clients
  --removeclient [client name]   remove an existing client
  --showclientqr [client name]   show QR code for an existing client
  --uninstall                    remove WireGuard and delete all configuration
  -y, --yes                      assume "yes" as answer to prompts when removing a client or removing WireGuard
  -h, --help                     show this help message and exit

Install options (optional):

  --auto                         auto install WireGuard using default or custom options
  --serveraddr [DNS name or IP]  server address, must be a fully qualified domain name (FQDN) or an IPv4 address
  --port [number]                port for WireGuard (1-65535, default: 51820)
  --clientname [client name]     name for the first WireGuard client (default: client)
  --dns1 [DNS server IP]         primary DNS server for first client (default: Google Public DNS)
  --dns2 [DNS server IP]         secondary DNS server for first client

To customize options, you may also run this script without arguments.