General Directives
The following directives configure the general behaviour of RealityServer.
include
| Description | Includes other files into the RealityServer configuration |
| Syntax | include filename |
| Context | global |
| Default | none |
This directive allows inclusion of other configuration files.
mime_types
| Description | Specifies a file containing mime-type definitions |
| Syntax | mime_types filename |
| Context | global |
| Default | none |
The name of a file the contains mappings from file name extensions to MIME types, which tell the browser what to do with the data. The file follows Apache syntax: lines beginning with # are comments; all others begin with a MIME type name followed by one or more space separated extensions, all case-insensitive.
add_mime_type
| Description | Adds a mime type description |
| Syntax | add_mime_type type extension |
| Context | global |
| Default | none |
An alternative to using a mime types file is to add them using this directive. Extensions added with this directive will override ones added in a mime_types file. Note that unlike the mime_types file only one extension can be specified per directive. Use multiple directives to associate multiple extensions with a single mime-type.
content_root
| Description | Specifies the root directory for all content |
| Syntax | content_root directory-path |
| Context | global |
| Default | none |
content_root specifies the directory which is the root of all content. The directory-path argument is the path this directory. Incoming URLs (after processing by a state module) are mapped directly into this path.
admin_address
| Description | Neuray library admin page address |
| Syntax | admin_address [address:]port |
| Context | global |
| Default | 0.0.0.0:8081 |
The address and port number, separated by a colon, or only the port number, that RealityServer accepts administration requests on. The address 0.0.0.0 means "any interface"; other addresses identify a network interface. The administration console is for system administrators only, to monitor the operation of RealityServer; it should under no circumstances be made available on a public network).
IPv6 addresses can also be specified but have to be surrounded with '[' and ']' to make it possible to disambiguate if a port is specified or not. The [::] is the IPv6 version of the ``any interface''. An example of binding to a specific address on port 8081 would be [fd00:172:16::b9]:8081.
<user>
| Description | Encloses a group of user defined directives. |
| Syntax | <user value> ... </user> |
| Context | global |
<user> and </user> are used to enclose a group of user defined configuration directives. These directives are not subjected to any validity checks other than that they conform to the general directive syntax. They are ignored by RealityServer and simply made available to user extensions via mi::rswservices::IConfiguration::get_user_configuration(const char *value). This way any user extension that requires configuration can simply add their configuration to the main file inside a plugin defined user directive and retrieve it when the extension is initialized.