Iray Bridge Directives
The following directives configure the Iray Bridge server.
bridge_server_enabled
| Description | Whether to enable the Iray Bridge server or not |
| Syntax | bridge_server_enabled on|off |
| Context | global |
| Default | off |
If set to "on" then RealityServer will setup an Iray Bridge server running on the same HTTP and/or HTTPS server you have configured for RealityServer itself. This enables compatible Iray enabled applications to use RealityServer as a rendering server with the Iray Bridge protocol. Please refer to your Iray application or the Iray SDK documentation for further details.
When connecting your application to RealityServer in this manner you will need to know the application path, the hostname, port and protocol used as well as the configured security token.
You construct the URL for accessing the bridge server as follows with your configuration details: [ws|wss]://[host]:[port][bridge_server_application_path]. If using HTTP then the protocol is ws://, for HTTPS it will be wss://.
If accessing the Iray Bridge server on a public network it is strongly recommended to use HTTPS only to avoid sending the security token in the clear.
bridge_server_application_path
| Description | The path appended to the URL to access the bridge server |
| Syntax | bridge_server_application_path [string] |
| Context | global |
| Default | /iray_bridge_server |
Sets the path that will be appended to the URL used to access the brige server. Note that this must begin with a / character to be valid. Ensure the path does not conflict with other paths that are configured to be served by RealityServer.
bridge_server_disk_cache_path
| Description | The directory in which Iray Bridge will store its cache data |
| Syntax | bridge_server_disk_cache_path [string] |
| Context | global |
| Default | cache |
Sets the directory where Iray Bridge will store its cache data. This allows Iray Bridge to retain previously uploaded content for later reuse. If the directory does not exist it will be created. Relative paths are relative to your RealityServer directory (the location of realityserver.conf).
bridge_server_snapshot_path
| Description | The directory in which Iray Bridge will store snapshots |
| Syntax | bridge_server_snapshot_path [string] |
| Context | global |
| Default | snapshot |
Sets the directory where Iray Bridge will store any snapshots it is requested to create. If the directorty does not exist it will be created when a snapshot is requested. Note that not all Iray Bridge clients will request snapshots. Relative paths are relative to your RealityServer directory (the location of realityserver.conf).
bridge_server_security_token
| Description | Security token required to access the Iray Bridge server |
| Syntax | bridge_server_security_token [string] |
| Context | global |
| Default | none |
Sets the security token that will be required by the Iray Bridge client to access the Iray Bridge server. This prevents unauthorized access to the bridge server. This directive is required in order for the bridge server to operate and it does not have a default value. You should supply a suitably difficult to guess string, similar to selecting a password.