Quick start
Sign up
Go to the registration page and sign up for a free account.
Create a HyperPath Network (i.e. HyperNet)
A HyperPath network is a Virtual Private Network (VPN) that is created and managed by you. You can create multiple HyperNets and each HyperNet can have multiple nodes or devices. Each HyperNet is isolated from other HyperNets and devices can only communicate with other devices within the same HyperNet.
After signing up, login and you will be greeted with an empty home page since you have not added any HyperNet yet.
Navigate to the HyperNets tab at the top menu and click on the Add HyperNet button. Provide a name and a description for your HyprNet and click on the Create button.
You should now be able to see your new HyprNet as shown below
Create a token
A token is a unique identifier that is used to identify and authenticate a device. You can create multiple tokens for each HyperNet and each token can be used to connect to the HyperNet from a single device at any one time.
To create a token, first click on the HyperNet to go to the manage HyperNet page.
Click on the Add Token button and it will navigate you to the Add Token page.
The following fields are required when creating a token:
| Attribute | Description |
|---|---|
| Name | A name for the token |
| Expiry Date | The date when the token will expire |
| Description | A description for the token |
| IPv4 | The IP address that will be assigned to the device when it connects to the HyperNet |
| Gateway | Which other node, if any, that will be used as a gateway by the device using this token |
| Scheduler | The multi-path scheduling algorithm |
| Useable Interfaces | Which network interfaces are used as part of the multi-path scheduling algorithm. You can use "." to use all interfaces or "eth." to use all interfaces that start with "eth" |
| Routes | which routes are available to other devices in the HyprNet via the device using this token |
| Setup Multihomed Routing | Whether HyperPath should configure multi-homed routing (if you do not know, you should leave this open checked) |
After filling out the required fields, click on the Add button to create the token. If the token is successfully created, a popup will appear with the command to install and configure HyperPath on the device using this token, as shown below.
Additionally, when you close the popup you will be able to see the token in the list of tokens for the HyperNet.
Clicking the computer icon on the right of the token will show you the popup with the command to install and configure HyperPath on the device using this token again.
Install and configure HyperPath
Linux
For Linux devices, you can use the command provided in the popup to install and configure HyperPath as a system service with the relevant token on the device. Currently, HyperPath supports Debian-based and OpenWRT-based distros. You can select the specific distro from the popup window dropdown box.
Debian-based distributions
In Debian-based distros, it will use the apt package manager to download and install HyperPath as a SystemD service.
If you run systemctl status hyperpath command, you should see that the HyperPath service is running, as shown below.
If you run ifconfig hp_tun command, you should see that the HyperPath interface is up and running, as shown below.
Additionally, if you go back to the Nodes page in the admin console, you should see that the node is online, as shown below.
OpenWRT distributions
Similairly, in OpenWRT-based distros, the installation script will download the HyperPath package and will use the opkg package manager to install it as an init.d service.
Once installed, HyperPath can be started as follows
/etc/init.d/hyperpath start
and stopped as follows
/etc/init.d/hyperpath stop
HyperPath OpenWRT version currently only supports Teltonika RUTx50 and was tested with Firmware version RUTX_R_00.07.11.3