This is an automated email from the ASF dual-hosted git repository.
cmcfarlen pushed a commit to branch 10.1.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/10.1.x by this push:
new ae2c568c88 Fix regex_remap doc for overridable config syntax (#12663)
(#12716)
ae2c568c88 is described below
commit ae2c568c8824c07cee04493104b1503ac9e2c6ec
Author: Brian Neradt <[email protected]>
AuthorDate: Tue Dec 2 17:27:24 2025 -0600
Fix regex_remap doc for overridable config syntax (#12663) (#12716)
The documentation incorrectly suggested using
@overridable-config=<value> syntax for overriding configuration
variables. No such overridable-config option exists. The correct syntax
is to use the config name directly with @<config-name>=<value> (e.g.,
@proxy.config.url_remap.pristine_host_hdr=0). This commit removes the
incorrect reference and adds an example.
(cherry picked from commit 69d1c79c02dd4ac01e31e68129c372abd119710b)
---
doc/admin-guide/plugins/regex_remap.en.rst | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/doc/admin-guide/plugins/regex_remap.en.rst
b/doc/admin-guide/plugins/regex_remap.en.rst
index 547309faca..7ac4001c61 100644
--- a/doc/admin-guide/plugins/regex_remap.en.rst
+++ b/doc/admin-guide/plugins/regex_remap.en.rst
@@ -139,11 +139,22 @@ remap.config. The following options are available ::
@connect_timeout=<nnn> - Connect timeouts (in ms)
@dns_timeout=<nnn> - Connect timeouts (in ms)
- @overridable-config=<value> - see :ref:`ts-overridable-config`
-
@caseless - Make regular expressions case insensitive
@lowercase_substitutions - Turn on (enable) lower case substitutions
+In addition to the options listed above, you can override any configuration
+variable from ``records.yaml`` on a per-rule basis. When a regex rule matches,
+any overridable configuration specified in that rule will be applied to the
+transaction. The syntax is ``@<config-name>=<value>``, for example ::
+
+ @proxy.config.url_remap.pristine_host_hdr=0
+ @proxy.config.http.cache.http=1
+
+These configuration overrides support integer, floating point, and string
values,
+and will be automatically converted to the appropriate type. See
+:ref:`ts-overridable-config` for the complete list of configuration variables
+that can be overridden.
+
This can be useful to force a particular response for some URLs, e.g. ::
@@ -155,3 +166,7 @@ Or, to force a 302 redirect ::
Setting the status to 301 or 302 will force the new URL to be used
as a redirect (Location:).
+
+You can also combine multiple options, including overridable configs ::
+
+ ^/(.*)?$ https://example.com/sitemaps/$1
@proxy.config.url_remap.pristine_host_hdr=0 @status=301
