Guide - Intershop Progressive Web App - Building and Running NGINX Docker Image

Personal Library

https://support.intershop.com/kb/30844H

Share this document

We provide a Docker image based on nginx for the PWA deployment.

Building

The Docker image can be built by running a Docker build with the Dockerfile located in the nginx folder.

Configuration

Mandatory environment variables:

Connect the nginx to the PWA with the UPSTREAM_PWA value in the form of http://<IP>:<PORT>

For HTTP, the server will run on default port 80.
For HTTPS, the server will run on default port 443.

We are using the standard nginx Docker image.
Therefore, we inherit all their configuration capabilities.
For further information please refer to the official nginx Docker image page

HTTPS or SSL

You can switch on HTTPS for the nginx container to execute a production-like setup locally or for demo purposes by changing ENV SSL=0 to ENV SSL=1 and adjusting the port mapping in docker-compose.yml.
No need to supply a certificate and a key.
They are automatically generated inside the running container.
The certificate is self-signed and will not work in your browser.
You have to confirm the security exception.
As developer convenience you can volume mount an internal folder to your host system to effectively trust the generated certificate.
Please check the nginx logs for the following output.

You can now export the local CA by adjusting your docker-compose.yml /home/your-user/ca-dir:/root/.local/share/mkcert/rootCA.pem

Basic Auth

For deploying to test environments that are not to be indexed by search bots or are not to be accessible by the public, the nginx container can be set up with basic authentication.
To do so, supply a single user-password combination as environment variable, i.e. BASIC_AUTH=<user>:<password>.
You can also whitelist IPs by supplying a YAML list to the environment variable BASIC_AUTH_IP_WHITELIST:

nginx:
  environment:
    BASIC_AUTH: 'developer:!InterShop00!'
    BASIC_AUTH_IP_WHITELIST: |
      - 172.22.0.1
      - 1.2.3.4

Entries of the IP whitelist are added to the nginx config as allow statements, which also supports IP ranges.
Please refer to the linked nginx documentation on how to configure this.

After globally activating basic authentication for your setup, you can also disable it selectively per site.
See Multi-Site Configurations for examples on how to do that.

Multi-Site

If the nginx container is run without further configuration, the default Angular CLI environment properties are not overridden.
Multiple PWA channels can be set up by supplying a YAML configuration listing all domains the PWA should work for.

For more information on the multi-site syntax, refer to Multi-Site Configurations

The configuration can be supplied by setting the environment variable MULTI_CHANNEL.
Alternatively, the source can be supplied by setting MULTI_CHANNEL_SOURCE in any supported format by gomplate.
If no environment variables for multi-channel configuration are provided, the configuration will fall back to the content of nginx/multi-channel.yaml, which can also be customized.

⚠️ Multi-Channel configuration with context paths does not work in conjunction with service workers.

An extended list of examples can be found in the Multi-Site Configurations guide.

Ignore Parameters During Caching

Often, nginx receives requests from advertising networks or various user agents that append unused query parameters when making a request, for example utm_source.

These parameters can lead to inefficient caching, because even if the same URL is requested multiple times, the cached version will not be used if the URL is accessed with different query parameters.

To prevent this, you can define any number of blacklisted parameters that will be ignored by nginx during caching.

As with multi-site handling above, the configuration can be supplied by setting the environment variable CACHING_IGNORE_PARAMS.

Alternatively, the source can be supplied by setting CACHING_IGNORE_PARAMS_SOURCE in any supported format by gomplate.
Be aware that the supplied list of parameters must be declared under a params property.

If no environment variables for ignoring parameters are provided, the configuration will fall back to the content of nginx/caching-ignore-params.yaml, which can also be customized.

Access ICM Sitemap

Please refer to Concept - XML Sitemaps on how to configure ICM to generate PWA sitemap files.

http://pwa/sitemap_pwa.xml

To make above sitemap index file available under your deployment, you need to add the environment variable ICM_BASE_URL to your nginx container.
Let ICM_BASE_URL point to your ICM backend installation, e.g., https://pwa-ish-demo.test.intershop.com.
When the container is started it will process cache-ignore and multi-channel templates as well as sitemap proxy rules like this:

location /sitemap_ {
proxy_pass https://pwa-ish-demo.test.intershop.com/INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/rest/inSPIRED-inTRONICS/en_US/sitemaps/pwa/sitemap_;
}

The process will utilize your Multi-Site Configuration.
Be sure to include application if you deviate from standard rest application.

Override Identity Providers by Path

The PWA can be configured with multiple identity providers.
In some use cases a specific identity provider must be selected when a certain route is requested.
For example, a punchout user should be logged in by the punchout identity provider requesting a punchout route.
For all other possible routes the default identity provider must be selected.
This can be done by setting only the environment variable OVERRIDE_IDENTITY_PROVIDER.

nginx:
  environment:
    OVERRIDE_IDENTITY_PROVIDERS: |
      .+:
        - path: /punchout
          type: Punchout

This setting will generate rewrite rules for the URL paths for all given domains.
Alternatively, the source can be supplied by setting OVERRIDE_IDENTITY_PROVIDERS_SOURCE in any supported format by gomplate.

If no environment variable is set, this feature is disabled.

Other

Built-in features can be enabled and disabled:

SSR=off effectively disables SSR rendering for browsers (default on)
CACHE=off disables caching (default on)
COMPRESSION=off disables compression (default on)
DEVICE_DETECTION=off disables user-agent detection (default on)
PROMETHEUS=on enables Prometheus metrics exports on port 9113 (default off)
SSL=on to switch on HTTPS. See HTTPS or SSL above for further explanation.
DEBUG=on to log extra information like path matching.
LOG_ALL=off to restrict logging to errors.

Features

New features can be supplied in the folder nginx/features.
A file named <feature>.conf is included if the environment variable <feature> is set to on, 1, true or yes (case insensitive).
Otherwise, the feature is disabled and an optional file <feature>-off.conf is included in the configuration.
The feature name must only contain word characters (letters, numbers, and underscore).

Cache

If the cache feature is switched off, all caching for pre-rendered pages is disabled.

The cache duration for pre-rendered pages can be customized using CACHE_DURATION_NGINX_OK (for successful responses) and CACHE_DURATION_NGINX_NF (for 404 responses).
The value supplied must be in the time format that is supported by nginx proxy_cache_valid.

Further References

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.