@@ -28,6 +28,8 @@ First, download the script on your Linux server\*:
28
28
wget -O wireguard.sh https://get.vpnsetup.net/wg
29
29
```
30
30
31
+ \* A cloud server, virtual private server (VPS) or dedicated server.
32
+
31
33
** Option 1:** Auto install WireGuard using default options.
32
34
33
35
``` bash
@@ -107,8 +109,29 @@ ANSWERS
107
109
108
110
** Note:** The install options may change in future versions of the script.
109
111
</details >
112
+ <details >
113
+ <summary >
114
+ View usage information for the WireGuard script.
115
+ </summary >
110
116
111
- \* A cloud server, virtual private server (VPS) or dedicated server.
117
+ ```
118
+ Usage: bash wireguard.sh [options]
119
+
120
+ Options:
121
+ --auto auto install WireGuard using default options
122
+ --addclient [client name] add a new client
123
+ --dns1 [DNS server IP] primary DNS server for new client (optional, defaults to Google Public DNS)
124
+ --dns2 [DNS server IP] secondary DNS server for new client (optional)
125
+ --listclients list the names of existing clients
126
+ --removeclient [client name] remove an existing client
127
+ --showclientqr [client name] show QR code for an existing client
128
+ --uninstall remove WireGuard and delete all configuration
129
+ -y, --yes assume "yes" as answer to prompts when removing a client or removing WireGuard
130
+ -h, --help show this help message and exit
131
+
132
+ To customize install options, run this script without arguments.
133
+ ```
134
+ </details >
112
135
113
136
## Next steps
114
137
@@ -139,6 +162,7 @@ List of enhancements over Nyr/wireguard-install.
139
162
- Supports listing existing VPN clients
140
163
- Supports showing QR code for a client
141
164
- Supports custom DNS server(s) for VPN clients
165
+ - Supports command-line options for managing VPN clients
142
166
- Optimizes ` sysctl ` settings for improved VPN performance
143
167
- Improved creation of client config files when using ` sudo `
144
168
0 commit comments