Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 10dc665

Browse files
Update private-locations.rst for validating no_proxy settings
1 parent 5813e0d commit 10dc665

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

synthetics/test-config/private-locations.rst

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,28 @@ NO_PROXY is configured to bypass the proxy for local addresses and specific doma
171171

172172
Ensure that these variables are correctly configured to comply with your network policies. This setup allows the synthetic tests to communicate securely and efficiently in a controlled network environment.
173173

174-
174+
When using runner, it's important to correctly configure the proxy settings to avoid issues with browser-based tests. The following steps should be followed when setting up their environment:
175+
176+
1. **Ensure Proper NO_PROXY Setup**:
177+
178+
- When configuring ``NO_PROXY``, it is critical that the following addresses are **always included**:
179+
180+
- ``127.0.0.1`` (for localhost communication)
181+
- ``localhost`` (for resolving local tests)
182+
183+
These addresses ensure that internal services and tests run correctly without routing through a proxy, preventing potential failures.
184+
185+
2. **Merging HTTP_PROXY and http_proxy**:
186+
187+
- The system automatically handles both ``HTTP_PROXY`` and ``http_proxy`` environment variables. If you define one of these, ensure the other is also set, or they will be automatically merged at start-up.
188+
189+
3. **Dockerfile Defaults**:
190+
191+
- By default, the runner will set the ``NO_PROXY`` variable in the Dockerfile to include ``127.0.0.1``. If you override ``NO_PROXY``, you must ensure that ``127.0.0.1`` and ``localhost`` are still present, or browser tests may fail.
192+
193+
4. **Startup Check**:
194+
195+
- The runner includes a startup check to validate that ``NO_PROXY`` contains ``127.0.0.1`` and ``localhost``. If these are missing, you may encounter unexpected behavior in test execution.
175196

176197

177198

0 commit comments

Comments
 (0)