Skip to content

Commit

Permalink
docs: add chapter running server side rendering with https
Browse files Browse the repository at this point in the history
  • Loading branch information
@jometzner @shauke
jometzner authored and shauke committed Feb 10, 2021
1 parent 8ce720d commit eeddc76
Showing 1 changed file with 30 additions and 18 deletions.
48 changes: 30 additions & 18 deletions docs/guides/ssr-startup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,36 @@ Only empty strings count as inactive.

If the format is _switch_, the property is switched on by supplying `on`, `1`, `yes` or `true` (checked case-insensitive), anything else is considered `off`.

| | parameter | format | comment |
| ------------------- | --------------------- | -------------------- | -------------------------------------------------------------------- |
| **SSR Specific** | PORT | number | Port for running the application |
| | SSL | any | Enables TLS (expects `server.crt` and `server.key` in `dist` folder) |
| **General** | ICM_BASE_URL | string | Sets the base URL for the ICM |
| | ICM_CHANNEL | string | Overrides the default channel |
| | ICM_APPLICATION | string | Overrides the default application |
| | FEATURES | comma-separated list | Overrides active features |
| | THEME | string | Overrides the default theme |
| **Debug** :warning: | TRUST_ICM | any | Use this if ICM is deployed with an insecure certificate |
| | LOGGING | switch | Enables extra log output |
| **Hybrid Approach** | SSR_HYBRID | any | Enables running PWA and ICM in [Hybrid Mode][concept-hybrid] |
| | PROXY_ICM | any \| URL | Proxy ICM via `/INTERSHOP` (enabled if SSR_HYBRID is active) |
| **Third party** | GTM_TOKEN | string | Token for Google Tag Manager |
| | SENTRY_DSN | string | Sentry DSN URL for using Sentry Error Monitor |
| | PROMETHEUS | switch | Exposes Prometheus metrics |
| | ICM_IDENTITY_PROVIDER | string | ID of Identity Provider for [SSO][concept-sso] |
| | IDENTITY_PROVIDERS | JSON | Configuration of Identity Providers for [SSO][concept-sso] |
All parameters are **case sensitive**.
Make sure to use them as written in the table below.

| | parameter | format | comment |
| ------------------- | --------------------- | -------------------- | ------------------------------------------------------------ |
| **SSR Specific** | PORT | number | Port for running the application |
| | SSL | any | Enables SSL/TLS |
| **General** | ICM_BASE_URL | string | Sets the base URL for the ICM |
| | ICM_CHANNEL | string | Overrides the default channel |
| | ICM_APPLICATION | string | Overrides the default application |
| | FEATURES | comma-separated list | Overrides active features |
| | THEME | string | Overrides the default theme |
| **Debug** :warning: | TRUST_ICM | any | Use this if ICM is deployed with an insecure certificate |
| | LOGGING | switch | Enables extra log output |
| **Hybrid Approach** | SSR_HYBRID | any | Enables running PWA and ICM in [Hybrid Mode][concept-hybrid] |
| | PROXY_ICM | any \| URL | Proxy ICM via `/INTERSHOP` (enabled if SSR_HYBRID is active) |
| **Third party** | GTM_TOKEN | string | Token for Google Tag Manager |
| | SENTRY_DSN | string | Sentry DSN URL for using Sentry Error Monitor |
| | PROMETHEUS | switch | Exposes Prometheus metrics |
| | ICM_IDENTITY_PROVIDER | string | ID of Identity Provider for [SSO][concept-sso] |
| | IDENTITY_PROVIDERS | JSON | Configuration of Identity Providers for [SSO][concept-sso] |

## Running with https

We deliver a selfsigned x509 certifciate for local development/deployment purposes only.
For obvious reasons (e.g we do not know your hostname) we cannot deliver a certificate that is accepted by web browsers.
Therefore be prepared for security questions when first accessing the site.

Our image build process is expecting files `server.crt` and `server.key` in folder `dist`.
Extension `crt` is the certifcate and `key` represents the private key.

# Further References

Expand Down

0 comments on commit eeddc76

Please sign in to comment.