diff --git a/CHANGELOG.md b/CHANGELOG.md index 617c18b8..01f9884e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # CHANGELOG +## v0.4.38 + +FEATURE: Conditionally enable interstitial page based on `User-Agent` prefix list. See the [template configuration](etc/frontend.yml) for details on the new configuration structure (https://github.com/openziti/zrok/issues/715) + +CHANGE: The interstitial configuration has been modified from a simple `interstitial: ` to a richer structure, but the config version has not been incremented; this feature has not been widely adopted yet. + ## v0.4.37 FIX: Fix for setting the `zrok_interstitial` cookie on Chrome-based browsers. diff --git a/etc/frontend.yml b/etc/frontend.yml index 7ea7e861..ecf723a9 100644 --- a/etc/frontend.yml +++ b/etc/frontend.yml @@ -10,10 +10,19 @@ v: 3 # #host_match: zrok.io -# Setting the `interstitial` setting to `true` will allow this frontend to offer interstitial pages if they are -# configured on the share by the controller. +# Configure interstitial pages for this frontend. The interstitial page presents a warning to internet users, alerting +# them to the fact that they're visiting a zrok share. # -#interstitial: true +#interstitial: +# # Enable or disable interstitial pages on this frontend. +# # +# enabled: true +# +# # Specify a list of User-Agent prefixes that should receive the interstitial page. If interstitial pages are enabled +# # and this list is not set, all user agents will receive an interstitial page. +# # +# user_agent_prefixes: +# - "Mozilla/5.0" # The OAuth configuration is used when enabling OAuth authentication with your public frontend. #