starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-03-23 01:29:20 +01:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Adjust docs for proxying (#523)

Browse Source 
Update/polish up the documentation around http proxying
This commit is contained in:
Daniel Chao
2024-06-13 09:46:21 -07:00
committed by GitHub
parent 919de4838c
commit 3bd9214858
4 changed files with 55 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
stdlib/EvaluatorSettings.pkl
View File

@@ -94,8 +94,6 @@ http: Http?
/// Settings that control how Pkl talks to HTTP(S) servers.
class Http {
/// Configuration of the HTTP proxy to use.
///
/// If [null], uses the operating system's proxy configuration.
proxy: Proxy?
}
@@ -103,7 +101,11 @@ class Http {
class Proxy {
/// The proxy to use for HTTP(S) connections.
///
/// At the moment, only HTTP proxies are supported.
/// Only HTTP proxies are supported.
/// The proxy address must start with `http://`, and can only contain a host and a port.
/// If a port is omitted, it defaults to port `80`.
///
/// Proxy authentication is not supported.
///
/// Example:
/// ```
@@ -114,15 +116,19 @@ class Proxy {
/// Hosts to which all connections should bypass a proxy.
///
/// Values can be either hostnames, or IP addresses.
/// IP addresses can optionally be provided using [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation).
/// IP addresses can optionally be provided using
/// [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation).
///
/// The only wildcard is `"*"`, which disables all proxying.
/// The value `"*"` is a wildcard that disables proxying for all hosts.
///
/// A hostname matches all subdomains.
/// For example, `example.com` matches `foo.example.com`, but not `fooexample.com`.
/// A hostname that is prefixed with a dot matches the hostname itself,
/// so `.example.com` matches `example.com`.
///
/// Hostnames do not match their resolved IP addresses.
/// For example, the hostname `localhost` will not match `127.0.0.1`.
///
/// Optionally, a port can be specified.
/// If a port is omitted, all ports are matched.
///