resource_servers[]/cookies

Specifies the configuration information associated with the processing of cookies from the resource server.

Properties

NameTypeConstraintsDescription
junction_cookiejunction_cookie

resource_servers[]/cookies/junction_cookie

The reverse proxy can set a "junction cookie" in returned HTML pages indicating which resource server the page was served from.
This is useful for resource servers which dynamically generate URLs that may not be aware or capable of generating URLs containing the path which the reverse proxy served them from.

Junction Cookie Positions

positionDescription
inheadThe junction cookie is set in a JavaScript block within the <head> </head> tags of the page. This is required for HTML 4.01 compliance.
trailerThe junction cookie is set in a JavaScript block that is appended to the end of the HTML page.
httpheaderThe junction cookie is returned as a standard HTTP cookie in the HTTP response headers.

Junction Cookie Versions

versionDescription
onfocusThe JavaScript block will contain an onfocus event handler to ensure the correct junction cookie is used in a multiple-junction/multiple-browser-window scenario.
xhtml10The inserted JavaScript block is HTML 4.01 and XHTML 1.0 compliant.

Properties

NameTypeConstraintsDescription
positionstringValues: inhead, trailer, httpheaderControls the position in which the <script> block will be inserted. Refer to the Junction Cookie Positions table above for an explanation of these values.
versionstringValues: onfocus, xhtml10Controls how the cookie is set. This option is only valid for the inhead and trailer positions. Refer to the Junction Cookie Versions table above for an explanation of these values.
ensure_uniquebooleanValues: true or false

Default value: false
A boolean flag indicating whether or not to insert the resource server path or host to ensure that the cookie is unique.
preserve_namebooleanValues: true or false

Default value: false
A boolean flag indicating whether or not to preserve the original cookie name. When set to false, non-domain cookies are renamed AMWEBJCT!<path>.

Example

resource_servers:
  - path: "/example"
    # ...
    cookies:
      junction_cookie:
        position: inhead
        version: onfocus
        ensure_unique: true
        preserve_name: true

Did this page help you?