Blame

f06ac2 Samuli Seppänen 2025-02-12 14:30:34 1
# Using the OpenVPN-GUI for Windows
2
3
4
----
5
6
7
**Important Note**: Please see the Official Readme here: https://github.com/OpenVPN/openvpn-gui#readme
8
9
10
----
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 11
12
13
14
15
**Notes:**
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 16
- This page **requires** that you have already installed [OpenVPN on a Windows OS Computer](https://openvpn.net/community-downloads/)
17
18
- For Windows XP/Vista see the old [wiki:OpenVPN-GUI]
19
20
- Some of the screenshots here may not accurately match the current OpenVPN-GUI.
21
22
23
24
----
25
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 26
27
## Locating the OpenVPN-GUI
28
29
The OpenVPN-GUI Tray Icon:
30
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 31
![01-tray-icon.png](./01-tray-icon.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 32
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 33
If you cannot find the OpenVPN-GUI icon then check that Windows has not hidden it from you.
34
(Because Windows likes to hide things from you ..)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 35
36
Windows hidden icons:
37
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 38
![show-hidden-icons.png](./show-hidden-icons.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 39
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 40
If you still cannot find the OpenVPN-GUI then make sure you opened it in the first place.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 41
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 42
You may use a desktop icon or the Windows menu to locate the OpenVPN-GUI.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 43
44
This is the OpenVPN-GUI desktop icon:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 45
46
![openvpn-gui-icon.png](./openvpn-gui-icon.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 47
48
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 49
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 50
* You should now have access to the OpenVPN-GUI.
51
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 52
53
----
54
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 55
56
## Preparing your installation to use the OpenVPN-GUI successfully
57
58
If you encounter this problem:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 59
Message dialogue `No readable connection profiles found`
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 60
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 61
![msg-no-configs.png](./msg-no-configs.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 62
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 63
Press OK -- You **must** have a configuration file to continue.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 64
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 65
If you are creating your own VPN server and client then please go [http://openvpn.net/index.php/open-source/documentation/howto.html here]
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 66
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 67
If you already have a client configuration file to a VPN then now is the time to import it.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 68
69
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 70
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 71
* You should now have a configuration file to import.
72
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 73
74
----
75
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 76
77
If you encounter this problem:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 78
Message dialogue `There already exists a config file named ...`
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 79
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 80
![msg-filename-conflict.png](./msg-filename-conflict.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 81
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 82
Press OK -- All config files **must** have unique names.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 83
84
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 85
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 86
* OpenVPN-GUI searches the entire directory tree (including sub-directories) of the following locations:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 87
* `\Program Files\OpenVPN\config` (`\Program Files` is the default installation directory)
88
* `\Users\$USERNAME\OpenVPN\config`
89
90
All `*.ovpn` files in these locations, including sub-directories, **must** have unique names.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 91
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 92
----
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 93
94
95
## Importing your first connection profile (config file) into the OpenVPN-GUI
96
97
Select "Import->Import file ..." from the menu, then select the `config.ovpn` file you wish to import:
98
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 99
![import-menu1.png](./import-menu1.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 100
101
If the import is successful you will see:
102
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 103
![import-success.png](./import-success.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 104
105
If your server administrator has provided a URL, username and password for importing from the server, use "Import->Import from URL..." or "Import->Import from Access Server..." and complete the dialog that opens up.
106
107
Otherwise, check that you selected a correctly configured `*.ovpn` file.
108
109
If you do not know what to do then please contact your server's administrator for help.
110
111
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 112
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 113
* You should now have a successfully imported configuration file.
114
115
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 116
----
117
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 118
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 119
## Setting up membership of the OpenVPN Administrators local group
120
121
In order for your `limited user` account without administrator privileges to be able to use openvpn, your user account must be added to the `OpenVPN Administrators` group on your computer. This is normally done during the install phase but it may not have been done. If you see the message below you can select `Yes` but you will need the Local Administrator password to continue. If you do not have this password then please contact your network administrator for help.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 122
123
Message dialogue `Require membership in OpenVPN Administrators group`
124
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 125
![msg-req-group-ovpnadmin.png](./msg-req-group-ovpnadmin.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 126
127
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 128
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 129
* You **must** now be a member of the `Openvpn Administrators` group.
130
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 131
THIS STAGE MUST BE COMPLETED BY YOUR COMPUTER ADMINISTRATOR
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 132
133
* If you are logged in to your desktop with an Administrator account then this stage will be omitted.
134
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 135
136
137
138
----
139
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 140
141
## Navigating the OpenVPN-GUI menus
142
143
The Main menu with only 1 configuration file imported:
144
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 145
![main-1-connect.png](./main-1-connect.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 146
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 147
With only one configuration file the menu displays all actions directly.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 148
149
The Main menu with 2 configuration files imported:
150
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 151
![main-2-connect.png](./main-2-connect.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 152
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 153
With two or more configuration files the menus will be nested.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 154
155
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 156
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 157
* You now understand the OpenVPN-GUI menus.
158
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 159
160
----
161
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 162
163
## Viewing the log file
164
165
The Main menu view log file:
166
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 167
![main-2-view-log.png](./main-2-view-log.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 168
169
Additional notes:
170
* A good application for viewing your log file is `BareTail`.
171
172
* You now have access to your VPN log file.
173
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 174
175
----
176
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 177
178
## Editing the configuration file
179
180
The Main menu edit config file:
181
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 182
![main-2-edit-config.png](./main-2-edit-config.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 183
184
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 185
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 186
* A good application for editing configuration files is `Notepad++`.
187
188
* You now have access to your configuration file.
189
190
**WARNING**
191
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 192
Do not edit your client configuration file unless you know what you are doing! [[br]]
193
https://openvpn.net/index.php/open-source/documentation/howto.html
194
195
196
----
197
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 198
199
200
## Entering Username and Password
201
202
Username / Password dialogue:
203
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 204
![userpass.png](./userpass.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 205
206
If your server requires a username and password you will see this dialogue box.
207
208
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 209
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 210
* Your client.ovpn file **must** contain the `--auth-user-pass` directive.
211
212
* You can choose to save the password but the username is always saved.
213
214
* These settings are saved in the Windows Registry under : `HKCU\Software\OpenVPN-GUI`
215
216
* The "enter user/pass timeout" can not be configured
217
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 218
The way it works is like this: if username/password is available, the dialog window is prefilled and displayed for 6 seconds. If during that time the user clicks on the window, the timeout is cancelled and the dialog stays on the screen until manually submitted. Otherwise it's auto-submitted after the 6 seconds timeout.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 219
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 220
The 6 seconds value is not configurable.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 221
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 222
If silent-connection is enabled and the username/password are saved then the dialog is not shown.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 223
224
**WARNING**
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 225
Editing the Windows Registry is **strongly discouraged** .. Do so ONLY AT YOUR OWN RISK!
226
227
228
----
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 229
230
231
## Trouble shooting
232
233
Error connecting:
234
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 235
![error-connecting.png](./error-connecting.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 236
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 237
The first thing to do is [#gui-logfile examine your log file] for details of the errors encountered.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 238
239
Additional notes:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 240
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 241
* For help with trouble shooting connection problems please see [HOWTO: Request Help ! {2}](https://forums.openvpn.net/viewtopic.php?f=30&t=22603#p68963)
242
243
Common connection problems:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 244
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 245
* `TLS Error: TLS key negotiation failed to occur within 60 seconds`
246
This means that you cannot reach the server -- Please contact your server administrator for help.
247
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 248
Please help improve this section.
249
250
251
----
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 252
253
254
## OpenVPN-GUI Settings
255
256
Most of the OpenVPN-GUI settings can be left as default but you should examine them to make sure this suites your requirements.
257
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 258
### The Settings menu, General tab
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 259
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 260
![setings-general.png](./setings-general.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 261
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 262
### The Settings menu, Proxy tab
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 263
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 264
![settings-proxy.png](./settings-proxy.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 265
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 266
### The Settings menu, Advanced tab
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 267
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 268
![settings-advanced.png](./settings-advanced.png)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 269
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 270
### The Settings menu, About tab
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 271
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 272
![settings-about.png](./settings-about.png)
273
274
275
----
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 276
277
278
You are now ready to use OpenVPN-GUI for Windows.
279
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 280
281
----
282
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 283
284
## Built-in help
285
286
See: `openvpn-gui.exe --help`
287
288
Note: The help text within `oenvpn-gui.exe` is out dated and awaiting update, the text here is a work in progress.
289
290
`--connect`
291
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 292
`--connect cnn` : Connect to `cnn` **at startup**. [[br]]
293
(File extension is optional, default is .ovpn)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 294
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 295
Example: `openvpn-gui --connect office.ovpn`
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 296
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 297
Example: `openvpn-gui --command connect office` (See `--command` below)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 298
299
`--command`
300
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 301
`--command cmd [args]` : Send a command `cmd` to **a running instance** of the GUI. [[br]]
302
(File extension is optional, default is .ovpn)
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 303
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 304
Supported commands:
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 305
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 306
| **Command** | **Description** | **Status** |
307
|-|-|-|
308
| `connect cnn` | connect the config named `cnn` | Supported |
309
| `disconnect cnn` | disconnect the config named `cnn` | Supported |
310
| `reconnect cnn` | reconnect the config named `cnn` | Supported |
311
| `disconnect_all` | disconnect all connected configs | Supported |
312
| `exit` | terminate the running GUI instance (may ask for confirmation) | Supported |
313
| `status cnn` | show the status window of config `cnn` if connected | Supported |
314
| `silent_connection [0|1]` | set the silent_connection flag on (1) or off (0) | Supported |
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 315
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 316
Example: `openvpn-gui.exe --command disconnect office`
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 317
318
Command line options that override persisted settings:
319
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 320
(Note: Some of these options are obsolete and should not be used.)
321
322
| **Option** | **Description** | **Status** |
323
|-|-|-|
324
| --exe_path path | Path to openvpn.exe. | Obsolete |
325
| --config_dir path | Path to dir to search for config files in. | Supported |
326
| --ext_string ext | Extension on config files. | Supported |
327
| --log_dir path | Path to dir where log files will be saved. | Supported |
328
| --priority_string str | Priority string. (See install.txt for more info) | Obsolete |
329
| --log_append bool | 1=Append to log file. 0=Truncate logfile when connecting. | Supported |
330
| --log_viewer path | Path to log viewer. | Supported |
331
| --editor path | Path to config editor. | Supported |
332
| --show_balloon bool | 0=Never, 1=At initial connect, 2=At every reconnect. | Supported |
333
| --silent_connection bool | 1=Do not show the status dialog while connecting or non-critical warnings at startup. | Supported |
334
| --show_script_window bool | 0=Hide Script execution window, 1=Show it. | Supported |
335
| --connectscript_timeout s | Time to wait for connect script to finish. | Supported |
336
| --disconnectscript_timeout s | Time to wait for disconnect script to finish. | Supported |
337
| --preconnectscript_timeout s | Time to wait for preconnect script to finish. | Supported |
338
| --iservice-admin bool | Use of interactive service as admin (0 = allow, 1 = not allow). Default is 1 for Windows 7+ | Supported |
339
| --disable_popup_messages | Do not show echo messages received from server | Supported |
340
| --popup_mute_interval hours | Time for which a previously shown echo message is not re-displayed | Supported |
341
| --config_menu_view type | 0 = Auto, 1 = Flat, 2 = Nested | Supported |
342
| --management-port-offset | Offset number added to config file index to determine the management port | Supported |
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 343
344
The default log viewer and editor are set by file association. Any value specified on the command line is used only when no default is found.
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 345
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 346
347
Example: `n/a`
348
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 349
350
----
351
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 352
353
## Contributing
354
355
You **can** help .. by simply taking part.
356
357
search (your choice) : `site:openvpn.net "what ever you need"`
358
359
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 360
----
361
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 362
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 363
OpenVPN-GUI README.rst : `https://github.com/OpenVPN/openvpn-gui/blob/master/README.rst` [[br]]
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 364
365
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 366
----
367
368
369
## Common connection problems
370
371
When you [#gui-logfile examine your log file], if this is the **only** output which you find:
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 372
```
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 373
Thu Jul 26 23:51:48 2018 OpenVPN 2.4.6 x86_64-w64-mingw32 [SSL (OpenSSL) [LZO] [LZ4] [PKCS11] [AEAD] built on Apr 26 2018
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 374
Thu Jul 26 23:51:48 2018 Windows version 6.1 (Windows 7) 64bit
375
Thu Jul 26 23:51:48 2018 library versions: OpenSSL 1.1.0h 27 Mar 2018, LZO 2.10
376
Enter Management Password:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 377
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 378
```
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 379
Then the most likely cause is that OpenVPN has already started the connection profile. [[br]]
380
You must ensure that all `openvpn.exe` processes are terminated and then try again.[[br]]
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 381
382
The most common cause of this problem is when you use the incorrect OpenVPN Windows services:
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 383
* **Stop** and **do not use** both the `OpenVPNService` and the `OpenVPN Legacy Service` Windows services. [[br]]
384
* **Start** and **do use** the `OpenVPN Interactive Service` Windows service.
385
386
387
----
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 388
389
390
## Known issues
391
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 392
* Windows 10: If your TAP adapter fails to start but you are using a known good config that used to work with Windows 7:
393
394
Try unplugging the ethernet cable and disabling wifi after you install Openvpn then reconnect the cable or reconnect to your wifi and try Openvpn again.
8aaea8 Samuli Seppänen 2025-02-11 07:16:22 395
396
f06ac2 Samuli Seppänen 2025-02-12 14:30:34 397
----