Proxy

The Intelligence Hub can run behind a reverse proxy. The user interface, the configuration API (default port 45245), and the data server that hosts the REST Data, MCP, and I3X endpoints (default port 8885) all serve their content using relative paths. As a result, the application can be served from a sub-path (for example https://example.com/hub/) without any additional configuration.

How it works

The frontend derives its API base from the location where the user interface is served, so any path prefix added by the proxy is preserved automatically.
The configuration server builds redirects relative to the incoming request. When the proxy sends an X-Forwarded-Prefix header, redirects (such as the redirect to the login page or the user interface) resolve under that external prefix.

Forwarded headers

Configure the proxy to forward the standard headers for the upstream scheme, host, and port. If the application is served from a sub-path, also send X-Forwarded-Prefix set to that sub-path so the configuration server can build redirects that resolve under the external URL.

Overrides

In most deployments no override is required. The settings below are only needed when the relative resolution is not sufficient, for example when the external URL must be a fixed, absolute value.

Override	Where it is set	Effect
Frontend base URL	`apiBaseUrl` in the frontend settings file served at `config/settings.json`	The frontend uses this absolute URL as the API base instead of deriving it from the served location.
`HIGHBYTE_BASE_URL`	Runtime environment variable, read once at startup	The configuration server builds absolute redirects against this value, for example `<HIGHBYTE_BASE_URL>/ui/index.html`.

HIGHBYTE_BASE_URL is read when the runtime starts. Changing it requires a restart to take effect.

Example

The following nginx fragment serves the Intelligence Hub under the /hub/ sub-path. Replace the host and ports with values for your environment.

location /hub/ {
    proxy_pass http://intelligence-hub:45245/;
    proxy_set_header Host              $host;
    proxy_set_header X-Forwarded-Host  $host;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-Prefix /hub;
}

For details on the data server endpoints that may also be proxied, see the HTTP Server settings.