Proxy settings

Proxy settings in the repository database

The Qlik Sense Proxy Service (QPS) retrieves its settings from the Qlik Sense Repository Service (QRS). The first poll is done at the start-up of the QPS. If the QRS does not respond, the QPS keeps polling the QRS for settings without forwarding any traffic. When the initial poll has been successfully completed, the QPS subscribes to changes to its settings. The QRS notifies the QPS when it is time for a new poll.

Normally, the Qlik Management Console (QMC) is used to manage the QPS settings, but the settings can also be changed using the QRS API. The following REST endpoints in the QRS API are relevant for the QPS:

• GET /qrs/proxyservice/{id}
• PUT /qrs/proxyservice/{id}
• POST /qrs/virtualproxyconfig
• GET /qrs/virtualproxyconfig/{id}
• DELETE /qrs/virtualproxyconfig/{id}
• PUT /qrs/virtualproxyconfig/{id}

A ProxyService has a child object, ProxyServiceSettings, which, in turn, refers to one or more VirtualProxyConfig entities.

Virtual proxy configuration

A virtual proxy configuration is a set of modules mapped to a prefix. There can be multiple virtual proxy configurations for a single proxy. This means that different modules can be used based on the URI that is used to access Qlik Sense or the Qlik Management Console (QMC).

The virtual proxy prefixes are configured together with the corresponding virtual server in the QRS.

When the QPS receives a request from a client, the virtual proxy prefix from the request URL has to be determined in order to map it to the correct virtual proxy. There is a whitelist of reserved, case-insensitive words that are preceded by the virtual proxy prefix (for example, qmc, client, hub, qps, and app). The virtual proxy prefix is the text in-between the hostname followed by a slash (/) and the reserved whitelist word preceded by a slash:

https://<somehost>/<virtual proxy prefix>/<reserved whitelist word>

Examples: Request URLs

• https://somehost/prefix/qmc: The virtual proxy prefix is “prefix”.
• https://somehost/prefix/subpath/qmc: The virtual proxy prefix is “prefix/subpath”.