= OpenVPN-GUI for Windows

**Note**: This page relates ''specifically'' to the OpenVPN-GUI which comes with **OpenVPN-2.4** or above.

 (For help using the OpenVPN-GUI which comes with OpenVPN-2.3 please go [https://community.openvpn.net/openvpn/wiki/OpenVPN-GUI here])

----

== Using OpenVPN-GUI for Windows

**Note**: This page requires that you have already installed OpenVPN-2.4 or above.

=== Preparing your installation to use the OpenVPN-GUI successfully

If you encounter this problem: Message dialogue `No readable connection profiles found`

 [[Image(msg-no-configs.png)]]

Press OK -- You must have a configuration file to continue.

If you are creating your own VPN server and client then please go [http://openvpn.net/index.php/open-source/documentation/howto.html here]

If you already have a client configuration file to a VPN then now is the time to import it.

Additional notes:

* You should now have a configuration file to import.

----

=== Locating the OpenVPN-GUI

The OpenVPN-GUI Tray Icon:

 [[Image(01-tray-icon.png)]]

If you cannot find the OpenVPN-GUI icon then check that Windows has not hidden it from you.\\
(because Windows likes to hide things from you ..)

Windows hidden icons:

 [[Image(show-hidden-icons.png)]]

If you still cannot find the OpenVPN_GUI then make sure you opened it in the first place.  

You may use a desktop icon or the Windows menu to locate the OpenVPN-GUI.

This is the OpenVPN-GUI desktop icon:
  [[Image(openvpn-gui-icon.png)]]

Additional notes:

* You should now have access to the OpenVPN-GUI

----

=== Importing your first connection profile (config file) into the OpenVPN-GUI

Select "Import file ..." from the menu, then select the `config.ovpn` file you wish to import:

 [[Image(import-menu.png)]]

If the import is successful you will see:

 [[Image(import-success.png)]]

Otherwise, check that you selected a correctly configured `*.ovpn` file.

If you do not know what to do then please contact your server's administrator for help.

Additional notes:

* You should now have a successfully imported configuration file.

----

=== Setting up membership of the OpenVPN Administrators local group

In order for your normal user to be able to use openvpn, your user account must be added to the ''OpenVPN Administrators local group'' on your computer.  This is normally done during the install phase but it may not have been.  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.

Message dialogue `Require membership of OpenVPN Administrators group`

 [[Image(msg-req-group-ovpnadmin.png)]]

Additional notes:

* You should now be a member of the Openvpn administrator group.

----

=== Navigating the OpenVPN-GUI menus

The Main menu with only 1 configuration file imported:

 [[Image(main-1-connect.png)]]

 With only one configuration file the menu displays all actions directly.

The Main menu with 2 configuration files imported:

 [[Image(main-2-connect.png)]]

 With two or more configuration files the menu will be nested.

Additional notes:

----

=== Viewing the log file

The Main menu view log file:

 [[Image(main-2-view-log.png)]]

Additional notes:
 A good application for viewing your log file is `BareTail`.

* You now have access to your VPN log file.

----

=== Editing the configuration file

The Main menu edit config file:

 [[Image(main-2-edit-config.png)]]

Additional notes:
 A good application for editing configuration files is `Notepad++`.

* You now have access to your configuration file.

----

=== Trouble with connecting to a server

Error connecting:

 [[Image(error-connecting.png)]]

The first thing to do is examine your log file for details of the errors encountered. (See above)

Additional notes:

----

=== OpenVPN-GUI Settings

Most of the OpenVPN-GUI settings can be left as default but you should examine them to make sure this suites your requirements.

The Settings menu, **General** tab:

 [[Image(setings-general.png)]]

The Settings menu, **Proxy** tab:

 [[Image(settings-proxy.png)]]

The Settings menu, **Advanced** tab:

 [[Image(settings-advanced.png)]]

The Settings menu, **About** tab:

 [[Image(settings-about.png)]]

----

You should now be ready to use OpenVPN-GUI for Windows.