Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated as per DOCS-1261

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

Object Creation: 

Code Block
CreateObject("roOpenVpn")

OpenVpnParams

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)

The following command should be called to close the vpn connection when the vpn connection is no longer needed:

Code Block
ovpn.Uninstall()
Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px