Engdocs 2038 #19698
Merged
Engdocs 2038 #19698
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
area/desktop
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
dvdksn
reviewed
Mar 27, 2024
| - `mode`: Same meaning as with the existing `proxy` setting. Possible values are `system` and `manual`. | ||
| - `http`, `https`, `exclude`: Same meaning as with the `proxy` setting. Only takes effect if `mode` is set to `manual`. | ||
| - `pac` : URL for a PAC file. Only takes effect if `mode` is `manual`, and is considered higher priority than `http`, `https`, `exclude`. | ||
| - `transparentPorts`: A comma-separated list of ports (e.g. `80`,`443`,`8080`) or a wildcard (`*`) indicating which ports should be proxied. |
There was a problem hiding this comment.
I guess this should be a single string?
Suggested change
| - `transparentPorts`: A comma-separated list of ports (e.g. `80`,`443`,`8080`) or a wildcard (`*`) indicating which ports should be proxied. | |
| - `transparentPorts`: A comma-separated list of ports (for example, `"80,443,8080"`) or a wildcard (`*`) indicating which ports should be proxied. |
|
|
||
| ## Example PAC file | ||
|
|
||
| For general information about PAC files, see the [Mozilla documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file). |
There was a problem hiding this comment.
Suggested change
| For general information about PAC files, see the [Mozilla documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file). | |
| For general information about PAC files, see [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file). |
| } | ||
| ``` | ||
|
|
||
| The url parameter is either `http://host_or_ip:port` or `https://host_or_ip:port`. |
There was a problem hiding this comment.
Suggested change
| The url parameter is either `http://host_or_ip:port` or `https://host_or_ip:port`. | |
| The `url` parameter is either `http://host_or_ip:port` or `https://host_or_ip:port`. |
| - `DIRECT`: Allows this request to go direct, without a proxy | ||
| - `PROXY reject.docker.internal:any_port`: Rejects this request | ||
|
|
||
| In this particular example HTTP and HTTPS requests for `internal.corp` are sent via the HTTP proxy `10.0.0.1:3128`. Requests to connect to IPs on the subnet `192.168.0.0/24` connect directly. All other requests are blocked. |
There was a problem hiding this comment.
Suggested change
| In this particular example HTTP and HTTPS requests for `internal.corp` are sent via the HTTP proxy `10.0.0.1:3128`. Requests to connect to IPs on the subnet `192.168.0.0/24` connect directly. All other requests are blocked. | |
| In this particular example, HTTP and HTTPS requests for `internal.corp` are sent via the HTTP proxy `10.0.0.1:3128`. Requests to connect to IPs on the subnet `192.168.0.0/24` connect directly. All other requests are blocked. |
|
|
||
| In this particular example HTTP and HTTPS requests for `internal.corp` are sent via the HTTP proxy `10.0.0.1:3128`. Requests to connect to IPs on the subnet `192.168.0.0/24` connect directly. All other requests are blocked. | ||
|
|
||
| To restrict traffic connecting to ports on the developers local machine, match the special hostname `host.docker.internal`. |
There was a problem hiding this comment.
I think a link here to where we describe host.docker.internal would be helpful
|
|
||
| ## Configuration | ||
|
|
||
| Assuming enforced sign-in and Settings Management are enabled, add the new proxy configuration to the `admin-settings.json` file. For example: |
There was a problem hiding this comment.
Maybe we could link to the docs for enforced sign-in and settings management here?
|
|
||
| - `locked`: If true, it is not possible for developers to override these settings. If false the settings are interpreted as default values which the developer can change. | ||
| - `mode`: Same meaning as with the existing `proxy` setting. Possible values are `system` and `manual`. | ||
| - `http`, `https`, `exclude`: Same meaning as with the `proxy` setting. Only takes effect if `mode` is set to `manual`. |
There was a problem hiding this comment.
These fields are not shown in the example above. I think it would be clearer if they were.
There was a problem hiding this comment.
If added to the example above they would be
"http": "",
"https": "",
"exclude": "",
(although watch out for the lack of comma on the last entry)
djs55
approved these changes
Apr 2, 2024
dvdksn
approved these changes
Apr 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Air-gapped containers (beta) feature. For DD4.29
Related issues or tickets
Reviews