Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
The roOpenVpn BrightScript API ensures that the files can be placed correctly, and with the right ownership, 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") |
ON THIS PAGE
| Table of Contents | ||
|---|---|---|
|
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 |
|---|
ovpn = CreateObject("roOpenVpn")
params = {}
params.archive_file = "openvpn.zip"
ovpn.InstallAndRun(params) |
The following command should be called to close the vpn connection when it is no longer needed:
| Code Block |
|---|
ovpn.Uninstall() |