Skip to content

Commit 01abcc2

Browse files
rm3ljmagak
andauthored
Apply suggestions from code review
Co-authored-by: jmagak <[email protected]>
1 parent 93a249c commit 01abcc2

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

assemblies/assembly-running-rhdh-behind-a-proxy.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ You can run the {product-very-short} application behind a corporate proxy by set
66
* `HTTP_PROXY`: Denotes the proxy to use for HTTP requests.
77
* `HTTPS_PROXY`: Denotes the proxy to use for HTTPS requests.
88

9-
Additionally, you can set the `NO_PROXY` environment variable to bypass the proxy for certain domains. The variable value is a list of domains or IP addresses that do not require a proxy to get reached, even if one is specified.
9+
Additionally, set the `NO_PROXY` environment variable to bypass the proxy for certain domains. The variable value is a list of domains or IP addresses that do not need a proxy to get reached, even when you specify one.
1010

1111
include::modules/admin/procedure-understanding-no-proxy.adoc[leveloffset=+1]
1212

modules/admin/procedure-understanding-no-proxy.adoc

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,32 @@
33

44
`NO_PROXY` is a comma or space-separated list of hostnames or IP addresses, optionally with port numbers. If the input URL matches any of the entries listed in `NO_PROXY`, then that URL will be fetched by a direct request (i.e., bypassing the proxy settings).
55

6-
Note that the default value for `NO_PROXY` in {product-very-short} is `localhost,127.0.0.1`. If you want to override it, please make sure to also include at least `localhost` or `localhost:7007` in the list; otherwise, the {product-very-short} Backend may not work correctly.
6+
[NOTE]
7+
====
8+
The default value for `NO_PROXY` in {product-very-short} is `localhost,127.0.0.1`. If you want to override it, include at least `localhost` or `localhost:7007` in the list. Otherwise, the {product-very-short} Backend may not work correctly.
9+
====
710

811
Matching follows the rules below:
912

1013
* `NO_PROXY=*` will bypass the proxy for all requests.
1114

12-
* Space and commas may be used to separate the entries in the `NO_PROXY` list. For example, `NO_PROXY=localhost,example.com`, `NO_PROXY="localhost example.com"`, or `NO_PROXY="localhost, example.com"` would have the same effect.
15+
* You may use space and commas may to separate the entries in the `NO_PROXY` list. For example, `NO_PROXY=localhost,example.com`, `NO_PROXY="localhost example.com"`, or `NO_PROXY="localhost, example.com"` would have the same effect.
1316

14-
* If `NO_PROXY` does not contain any entries, then all requests will be sent through the proxy if the `HTTP(S)_PROXY` settings are configured. Otherwise, requests will be fetched directly.
17+
* If `NO_PROXY` contains no entries, configuring the `HTTP(S)_PROXY` settings will make the Backend send all requests through the proxy. Otherwise, it fetches requests directly.
1518

16-
* No DNS lookup is performed to decide if a request should bypass the proxy or not. For example, if DNS is known to resolve `example.com` to `1.2.3.4`, setting `NO_PROXY=1.2.3.4` will not have any effect on requests sent to `example.com`. Only requests explicitly sent to the IP address `1.2.3.4` will bypass the proxy.
19+
* The Backend does not perform a DNS lookup to determine if a request should bypass the proxy or not. For example, if DNS is known to resolve `example.com` to `1.2.3.4`, setting `NO_PROXY=1.2.3.4` will not have any effect on requests sent to `example.com`. Only requests sent to the IP address `1.2.3.4` will bypass the proxy.
1720

18-
* If a port is added after the hostname or IP Address, then the input request must match both the host/IP and port in order to bypass the proxy. For example, `NO_PROXY=example.com:1234` would exclude requests to `http(s)://example.com:1234` (so calling them directly), but not requests to other ports like `http(s)://example.com` (which will be sent through the proxy).
21+
* If a port is added after the hostname or IP Address, then the input request must match both the host/IP and port in order to bypass the proxy. For example, `NO_PROXY=example.com:1234` would bypass the proxy for requests to `http(s)://example.com:1234`, but not for requests on other ports, like `http(s)://example.com`.
1922

2023
* If no port is specified after the hostname or IP address, all requests to that host/IP address will bypass the proxy regardless of the port. For example, `NO_PROXY=localhost` would exclude all requests sent to `localhost` (so calling them directly), like `http(s)://localhost:7077` and `http(s)://localhost:8888`.
2124

22-
* IP Address blocks in CIDR notation will not work. So setting `NO_PROXY=10.11.0.0/16` will not have any effect, even if a request is explicitly sent to an IP address in that block.
25+
* IP Address blocks in CIDR notation will not work. So setting `NO_PROXY=10.11.0.0/16` will not have any effect, even if the Backend sends a request to an IP address in that block.
2326

2427
* Only IPv4 addresses are supported. IPv6 addresses like `::1` will not work.
2528

26-
* Generally, the proxy is only bypassed if the hostname is an exact match for an entry in the `NO_PROXY` list. The only exceptions are entries that start with a dot (`.`) or with a wildcard (`*`). In such a case, the proxy is bypassed if the hostname ends with the entry. Please note that you should list both the domain and the wildcard domain if you want to exclude a given domain and all its subdomains. For example, you would set `NO_PROXY=example.com,.example.com` to bypass the proxy for requests sent to `http(s)://example.com` and `http(s)://subdomain.example.com`.
29+
* Generally, the proxy is only bypassed if the hostname is an exact match for an entry in the `NO_PROXY` list. The only exceptions are entries that start with a dot (`.`) or with a wildcard (`*`). In such a case, the proxy is bypassed if the hostname ends with the entry.
30+
31+
[NOTE]
32+
====
33+
List the domain and the wildcard domain if you want to exclude a given domain and all its subdomains. For example, you would set `NO_PROXY=example.com,.example.com` to bypass the proxy for requests sent to `http(s)://example.com` and `http(s)://subdomain.example.com`.
34+
====

0 commit comments

Comments
 (0)