Squash HTTP Headers
Squash provides custom HTTP headers that are always send to the applications running within Squash deployments. These headers provide users with more flexibility at the web server level.
Squash-Server
This header always have the value true
and is used to signal to applications that the request is coming from Squash. This is handy if you need to perform certain checks/operations that are meant to be specific to the Squash environment.
Squash-Original-Addr-Full
This header will display the full URL that users see in their browsers.
Example 1:
Deployment URL: https://cartv3-i3xg7.squash.io
Squash-Original-Addr-Full = https://cartv3-i3xg7.squash.io
Example 2:
Using a URL with path components and query strings. The header will always contain the full URL.
Deployment URL: https://cartv3-i3xg7.squash.io/path1/?abc=1
Squash-Original-Addr-Full = https://cartv3-i3xg7.squash.io/path1/?abc=1
Example 3:
For subdomains this header will also contain the original value in the URL.
Deployment URL: https://bookstore--cartv3-i3xg7.squash.io
Squash-Original-Addr-Full = https://bookstore--cartv3-i3xg7.squash.io
See details on how to use subdomains with Squash and defining subdomains in the .yml file.
Squash-Original-Addr
Same as Squash-Original-Addr-Full
but without the URL path components and URL query strings.
Example 1:
Deployment URL: https://cartv3-i3xg7.squash.io/path1/?abc=1
Squash-Original-Addr = https://cartv3-i3xg7.squash.io
Example 2:
Subdomains will still be included in the header.
Deployment URL: https://bookstore--cartv3-i3xg7.squash.io
Squash-Original-Addr = https://bookstore--cartv3-i3xg7.squash.io