docs: add note regarding COMPANION_CLIENT_ORIGINS_REGEX (#5322)

transloadit · Jul 10, 2024 · c6a671b · c6a671b
1 parent 682de7a
commit c6a671b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/companion.md b/docs/companion.md
@@ -655,6 +655,15 @@ boolean value `false`).
 
 ##### `COMPANION_CLIENT_ORIGINS_REGEX`
 
+:::note
+
+In most cases, you should not be using a regex, and instead provide the list of
+accepted origins to `COMPANION_CLIENT_ORIGINS`. If you have to use this option,
+have in mind that this regex will be used to parse unfiltered user input, so
+make sure you’re validating the entirety of the string.
+
+:::
+
 Like COMPANION_CLIENT_ORIGINS, but allows a single regex instead.
 `COMPANION_CLIENT_ORIGINS` will be ignored if this is used. This is a
 standalone-only option.