ADVANTECH OpenVPN Custom Config Router App User Guide
- June 14, 2024
- Advantech
Table of Contents
ADVANTECH OpenVPN Custom Config Router App
© 2023 Advantech Czech s.r.o. No part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photography, recording, or any information storage and retrieval system without written consent. Information in this manual is subject to change without notice, and it does not represent a commitment on the part of Advantech. Advantech Czech s.r.o. shall not be liable for incidental or consequential damages resulting from the furnishing, performance, or use of this manual. All brand names used in this manual are the registered trademarks of their respective owners. The use of trademarks or other designations in this publication is for reference purposes only and does not constitute an endorsement by the trademark holder.
Used symbols
- Danger – Information regarding user safety or potential damage to the router.
- Attention – Problems that can arise in specific situations.
- Information – Useful tips or information of special interest.
- Example – Example of function, command or script.
Changelog
- 1.1 OpenVPN Custom Config Changelog
- v1.0.1 (2018-03-19)
- First release
- v1.0.2 (2018-06-18)
- Generate ovpn files in the init script
- v1.1.0 (2020-10-01)
- Updated CSS and HTML code to match firmware 6.2.0+
Description of the module
Router app OpenVPN Custom Config is not contained in the standard router firmware. Uploading of this router app is described in the Configuration manual (see Chapter Related Documents). OpenVPN Custom Config router app can be used to configure up to four another OpenVPN tunnels on the router. This module has no classic configuration menu like the router’s OpenVPN configuration page has. Configuration of one OpenVPN tunnel is declared in one field supporting the format used in *.ovpn configuration file. Advantage of this solution is that an existing OpenVPN configuration can be easily applied to the router. The downside is, that there is no control for the configuration entered. You can then easily get into the situation when the tunnel is not established or not working as expected with limited possibility of issue debugging.
Web interface
Once the installation of the module is complete, the module’s GUI can be invoked by clicking the module name on the Router apps page of router’s web interface. Left part of this GUI contains menu with Status section, followed by Configuration section which contains the configuration pages for all of four OpenVPN tunnels. Customization section contains only the Return item, which switches back from the module’s web page to the router’s web configuration pages. The main menu of module’s GUI is shown on figure 1.
Module usage
Configuration page
Configuration section of the module’s GUI contains configuration pages for all
of four OpenVPN tunnels, from Tunnel 1 to Tunnel 4. Default state of
configuration page for Tunnel 1 is on figure 1.
As you can see, the configuration field begins with four lines which should not be edited. There are tunnel type and interface name declared on these lines. The interface name for Tunnel 1 is tun11 increasing to tun14 for Tunnel 4. Bellow these lines follows section four your configuration where you can put your configuration of the tunnel. Please note, that only OpenVPN features stated in configuration manual (references on page ??) of the router are declared to be supported by this module. Other settings may not work as expected.
An example of tunnel configuration is shown on figure 2. To save changes made in configuration click on Apply button. To apply the configuration and to create appropriate OpenVPN tunnel, check Enable box at the top and click on Apply button.
Status page
OpenVPN Status page lists status of all four OpenVPN interfaces. If the tunnel
is initialled, the interface name and its status is displayed. If the tunnel
is not enabled, the Disabled keyword is mentioned for the tunnel. An example
of status page is shown on figure 3.
Log page
OpenVPN Log page lists detailed log messages of all four OpenVPN interfaces
configured in this router app and also for all four standard OpenVPN
interfaces configured on router’s web GUI. These information may be helpful
for debugging, especially for issues with initialization of the interface
caused by an incorrect configuration. An example of log page is shown on
figure 4.
Related Documents
You can obtain product-related documents on Engineering Portal at icr.advantech.cz address. To get your router’s Quick Start Guide, User Manual, Configuration Manual, or Firmware go to the Router Models page, find the required model, and switch to the Manuals or Firmware tab, respectively. The Router Apps installation packages and manuals are available on the Router Apps page. For the Development Documents, go to the DevZone page.
References
- Advantech 4G, 5G Cellular Routers & Gateways for IoT applications - Engineering Portal
- Advantech 4G, 5G Cellular Routers & Gateways for IoT applications - Engineering Portal
- DevZone - Cellular Routers Engineering Portal
- Router Apps - Cellular Routers Engineering Portal
- Router Models - Cellular Routers Engineering Portal