NGINX JSON - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of Industrial Edge APIs - CLI tools - Industrial Edge - References - APIs

The JSON String passed as the nginxjson argument is a map of all container services which should be exposed trough the reverse proxy.

Each service has a list of section names which get redirected to that service.

The name defines this section under which the service will be available. If for example this is set to dashboard all requests coming to https://<device ip>/dashboard/ and all subpaths will be reverse proxied to the service.

If a service should be not be available under a direct string an additonal path can be added using the subpath argument. If we set it to foo/bar for example, the service would be available under https://<device ip>/dashboard/foo/bar/.

In the protocol field it is determined if incoming https requests should be terminated at the reverse proxy ("HTTP") and forwarded unencrypted or another secure connection should forward the traffic encrypted to the service.

The port defines the to which port of the service should be passed to. The port can not be exposed to the host at the same time.

With rewriteTarget it is determined how incoming requests get rewritten. If set to the default "/", requests get passed to the root. Any subdirectories after the name and subpath will then get passed along. If the rewriteTarget is for example set to "/baz" an incoming requests to https://<device ip>/dashboard/foo/bar/file.txt will be forwarded to the service as http://<service ip>/baz/file.txt.

isSecureRedirection allows only authenticated traffic to be redirected to your service.

When bypassUrlDecoding is set, all requests will be forwarded to the service without rewriting the request without the name and subpath.

If your application requires special proxy directives to be set they can added as an encoded json string in headers.

An example nginxjson could look like the following, including a lot of recommended proxy directives:

{
  "servicename": [
        {
            "name": "nginx",
            "protocol": "HTTP",
            "port": "80",
            "headers": "{\"proxy_http_version\":\"1.1\",\"proxy_set_header Upgrade\":\"$http_upgrade\",\"proxy_set_header Connection\":\"\\\"upgrade\\\"\",\"proxy_set_header Host\":\"$host\",\"proxy_set_header X-Real-IP\":\"$remote_addr\",\"proxy_set_header X-Forwarded-For\":\"$proxy_add_x_forwarded_for\",\"proxy_set_header X-Forwarded-Proto\":\"$scheme\",\"proxy_set_header X-Forwarded-Host\":\"$host\",\"proxy_set_header X-Forwarded-Port\":\"$server_port\"}",
            "rewriteTarget": "/",
            "subPath": "",
            "isSecureRedirection": false,
            "bypassUrlDecoding": false
        }
    ]
}