= OpenVPN-GUI for Windows **Notes:** * This page relates ''specifically'' to the OpenVPN-GUI included with **OpenVPN-2.4** or above. [[br]] - For help using the OpenVPN-GUI included with **OpenVPN-2.3** please go [https://community.openvpn.net/openvpn/wiki/OpenVPN-GUI here] [[br]] - This page requires that you have already installed OpenVPN-2.4 or above. **Contents:** 1. [#gui-prepare Preparing your installation to use the OpenVPN-GUI successfully] [[br]] 1. [#gui-locate Locating the OpenVPN-GUI] [[br]] 1. [#gui-import Importing your first connection profile (config file) into the OpenVPN-GUI] [[br]] 1. [#gui-group Setting up membership of the OpenVPN Administrators local group] [[br]] 1. [#gui-navigate Navigating the OpenVPN-GUI menus] [[br]] 1. [#gui-logfile Viewing the log file] [[br]] 1. [#gui-edit Editing the configuration file] [[br]] 1. [#gui-userpass Entering Username and Password] [[br]] 1. [#gui-trouble Trouble shooting] [[br]] 1. [#gui-settings Settings menu] [[br]] 1. [#gui-set-general Settings menu, General tab] [[br]] 1. [#gui-set-proxy Settings menu, Proxy tab] [[br]] 1. [#gui-set-advanced Settings menu, Advanced tab] [[br]] 1. [#gui-set-about Settings menu, About tab] [[br]] 1. [#gui-contrib Contribute] [[br]] ---- = Using OpenVPN-GUI for Windows == Preparing your installation to use the OpenVPN-GUI successfully #gui-prepare 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 #gui-locate 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. [[br]] (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 #gui-import 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 #gui-group In order for your `normal user` 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. Message dialogue `Require membership of OpenVPN Administrators group` [[Image(msg-req-group-ovpnadmin.png)]] Additional notes: * You **must** now be a member of the `Openvpn Administrators` group. THIS STAGE MUST BE COMPLETED .. ---- == Navigating the OpenVPN-GUI menus #gui-navigate 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 menus will be nested. Additional notes: * You now understand the OpenVPN-GUI menus. ---- == Viewing the log file #gui-logfile 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 #gui-edit 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. ---- == Entering Username and Password #gui-userpass Username / Password dialogue: [[Image(userpass.png)]] If your server requires a username and password you will see this dialogue box Additional notes: * Your client.ovpn file **must** contain the `--auth-user-pass` directive. * You can choose to save the password but the username is always saved. ---- == Trouble shooting #gui-trouble Error connecting: [[Image(error-connecting.png)]] The first thing to do is [#gui-logfile examine your log file] for details of the errors encountered. Additional notes: * For help with trouble shooting connection problems please see [https://forums.openvpn.net/viewtopic.php?f=30&t=22603#p68963 HOWTO: Request Help ! {2}] Common connection problems: * `TLS Error: TLS key negotiation failed to occur within 60 seconds` [[br]] This means that you cannot reach the server -- Please contact your server administrator for help. Please help improve this section, you can submit improvements [#gui-contrib here] ---- == OpenVPN-GUI Settings #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: #gui-set-general [[Image(setings-general.png)]] === The Settings menu, **Proxy** tab: #gui-set-proxy [[Image(settings-proxy.png)]] === The Settings menu, **Advanced** tab: #gui-set-advanced [[Image(settings-advanced.png)]] === The Settings menu, **About** tab: #gui-set-about [[Image(settings-about.png)]] ---- You are now ready to use OpenVPN-GUI for Windows. ---- === Contributing #gui-contrib You **can** help .. by simply taking part. search (your choice) : `site:openvpn.net "what ever you need"` Example: `please start a thread on the OpenVPN forum to improve the OpenVPN-GIU` The possibilities .. ---- `https://github.com/OpenVPN/openvpn-gui/blob/master/README.rst` [[br]] ----