Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated as per DOCS-1013
Insert excerpt
BrightScript Version Navigation Menu
BrightScript Version Navigation Menu
nopaneltrue

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


Object Creation: The roOpenVpn object must be passed an roAssetPoolinstance upon creation. 

Code Block
CreateObject("roOpenVpn")


OpenVpnParams



Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px


archive_file as string

Path to the configuration zip


obfuscated_secret as string

Encrypted passphrase for protected certificates


InstallAndRun(params as OpenVpnParams) as Boolean

Install the configuration and run it


openvpn Uninstall() as Boolean

Stop and uninstall the configuration


Example


Code Block
languagejs
 ovpn = CreateObject("roOpenVpn")
params = {}
params.archive_file = "openvpn.zip"
ovpn.InstallAndRun(params)
ovpn.Uninstall()