Skip to main content
Piebald Pro supports routing all traffic through a proxy. If you’ve configured Piebald to use the system proxy, it’ll automatically detect it and route all traffic through it. Otherwise, you can manually configure proxy details for Piebald to route through.

​
System proxy

Available in Piebald Pro To configure Piebald to detect and pass through the system proxy, go to Settings → Proxy and select System Proxy. This option is selected by default for all Pro users. When configured to use the system proxy, Piebald automatically detects HTTP, HTTPS, and SOCKS5 proxies. If Piebald detects that authentication is required to route requests through the detected proxy, it’ll attempt to use the user’s Windows credentials and authenticate through SSO. If that doesn’t work, Piebald will display a native dialog for users to sign in to the proxy.

​
Manually-configured proxy

Available in Piebald Pro To manually configure Piebald to pass through a proxy, follow these steps:
  1. Open Settings → Proxy.
  2. Choose Manual proxy.
  3. Configure the protocol (HTTP, HTTPS, or SOCKS5) and URL.
  4. Optionally enter a username and password.
  5. Optionally configure the bypass list (see below for details).

​
Bypass rules

Bypass rules tell apps that support proxies, like Piebald, to skip routing certain URLs through the proxy. In Piebald, bypass rules take the form of a comma-separated list. You can bypass addresses of these forms:
  • Exact hostnames (e.g. build-server).
  • Domain patterns (e.g. .example.com or *.example.com).
  • IP addresses (e.g. 192.168.50.134).
  • CIDR ranges (e.g. 10.0.0.0/8).
  • * to bypass the proxy for every URL.
So, to bypass all of the examples above, you’d use the following bypass list:

​
Environment variable proxy

Available in Piebald Basic (Free) Piebald Pro and Basic automatically searches for the proxy environment variables listed below and uses them to route requests. The proxy environment variables will override the system proxy if you’ve configured it (but they won’t override manual configuration or direct routing if that’s what you’ve configured). Piebald supports these proxy environment variables:
  • http_proxy / HTTP_PROXY is used for routing requests to HTTP URLs.
  • https_proxy / HTTPS_PROXY is used for routing requests to HTTPS URLs.
  • ftp_proxy / FTP_PROXY is used for routing requests to FTP (File Transfer Protocol) URLs.
  • all_proxy / ALL_PROXY is used when a request is made and one of the other environment variables aren’t set.
  • no_proxy / NO_PROXY is used as comma-separated list of what URLs should not be routed through the proxy, i.e. the bypass rules list detailed above.
If none of these environment variables are set, but SOCKS_SERVER is, and SOCKS_VERSION is set to 5, Piebald will route traffic through that server. But Piebald doesn’t support SOCKS_VERSION being set to 4. Note that Piebald doesn’t support these environment variables in their lowercase forms. Piebald currently doesn’t support auto_proxy / AUTO_PROXY environment variables for PAC file paths.

​
Proxy auto-config (PAC) files

If the configured proxy has a proxy auto-config (PAC) file, Piebald will read it and compiled it. On subsequent requests, Piebald evaluates the compiled PAC file and to determine which proxy, if any, to use. As noted above, PAC files specified by auto_proxy / AUTO_PROXY environment variables aren’t read or evaluated currently.

​
Requests that pass through proxies regardless of configuration

Some requests required by Piebald functionality still pass through the system proxy even if you configure the app to not use any proxy. This is to ensure that functionality isn’t broken by these requests failing. These requests include:
  • WorkOS sign-in.
  • Subscription checks.
  • Feedback submission.
  • Google Fonts listing.
  • Automatic error reporting.
  • Telemetry.