Skip to content

Skywire VPN Server

Moses Narrow edited this page Jul 8, 2022 · 7 revisions

Skywire VPN Server

Note that the configuration & starting/stopping of the Skywire VPN Server can also be performed using the Skywire HypervisorUI via the Apps page of the respective Visor.

Note: the vpn server can be enabled via environmental variable in the linux packages. Please refer to this guide

Generate configuration with VPN Server enabled

If you did not generate your configuration file, but have skywire working in front of you, It is recommended to follow any documentation or guidance specific to your installation of skywire (i.e. package or installer) rather than manually regenerating the config file with the VPN server enabled.

Generically, the command to generate the config with VPN server enabled is:

skywire-cli config gen --vpn-server-enable 

Set Passcode for VPN Server

The Skywire VPN server can be configured to require a passcode for authentication. In order to be publicly advertised in Skycoin's service discovery and eligible for the VPN rewards pool, a passcode must not be set

An example of setting a passcode for the vpn server

skywire-cli config update vpns -s <passcode>

Additional options for changing vpn server settings:

skywire-cli config update vpns --help

image

The "-secure" flag prevents VPN client users from SSH'ing into the VPN-server's machine. default true.

starting the VPN Server with skywire-cli

The following assumes that you either use multiple terminals or take care of detaching processes from the terminal yourself.

In order to run the Skywire VPN server, first ensure you have a running Visor. It's possible to check with:

skywire-cli visor info

the output of that command:

.:: Visor Summary ::.
Public key: "035b47c7cd9c8f1c1f69c4da63f3d57a64fd48f2c7fb1e320d30352316ac1f418c"
Symmetric NAT: false
IP: 192.168.0.2
DMSG Server: "0371ab4bcff7b121f4b91f6856d6740c6f9dc1fe716977850aeb5d84378b300a13"
Ping: "433.787805ms"
Visor Version: v0.6.0
Skybian Version: 
Uptime Tracker: healthy
Time Online: 3290.162095 seconds
Build Tag: linux_amd64

Note: The VPN server requires to be started as root to setup a TUN interface and configure the systems routing rules.

For now, be sure skywire-visor was started with elevated privelages.

To start the VPN server with skywire-cli:

skywire-cli visor app start vpn-server

To stop the VPN server with skywire-cli

skywire-cli visor app stop vpn-server
Clone this wiki locally