The JSON string passed as the nginxjson argument is a map of all container services that should be exposed through the reverse proxy.
Each service has a list of section names that will be redirected to that service:
-
The name defines the section under which the service will be available. For example, if 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 not be available under a direct string, an additional path can be added using the subpath argument. For example, if we set it to foo/bar, the service would be available under
https://<device ip>/dashboard/foo/bar/. -
The protocol field determines if incoming HTTPS requests should be terminated at the reverse proxy ("HTTP") and forwarded unencrypted, or if another secure connection should forward the traffic encrypted to the service.
-
The port defines the port of the service to which the traffic should be passed. The port cannot be exposed to the host at the same time.
-
The rewriteTarget setting determines how incoming requests are rewritten. If set to the default "", requests are passed to the root, and any subdirectories after the name and subpath will be passed along. If the rewriteTarget is set to "/baz", an incoming request to
https://<device ip>/dashboard/foo/bar/file.txtwill be forwarded to the service ashttp://<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 be added as an encoded JSON string in the headers field.
Tip
To pass informations about the request to the service a number of headers like X-Forwarded-For, X-Forwarded-Proto and X-Forwarded-Host can be used using the proxy_set_header directive.