openvpn

The openvpn object can be used to connect players and servers through a VPN, without making them accessible to everyone.

openvpn IDL

interface OpenVpnConfig {
    attribute String archiveFile;
    attribute String? obfuscatedSecret;
};

interface OpenVpn {
    Promise<void> installAndRun(OpenVpnConfig config);
    Promise<void> uninstall();
};

ON THIS PAGE

Object Creation

var openvpn = require('@brightsign/openvpn');
var ovpn = new openvpn();

OpenVpn

installAndRun()

Promise<void> installAndRun(params: OpenVpnParams)

Install the configuration and run OpenVPN.

uninstall()

Stop and uninstall the configuration

OpenVpnConfig

archiveFile string: Path to the configuration zip
obfuscatedSecret string: Encrypted passphrase for protected certificates

Example

This example sends logs to the SD card, but /storage/flash can also be used. Each method has a limitation: If you use an SD card location, you cannot remove the card while the OpenVPN client is active or you will get an error log and the card can be corrupted, while /storage/flash may not be available depending on the player that you are using.

Documentation