proxy.settings

A BrowserSetting object that can be used to change the browser's proxy settings.

The underlying value is an object with the properties listed below.

When setting this object, all properties are optional. Note that any properties that are omitted will be reset to their default value.

autoConfigUrlOptional
string. A URL to use to configure the proxy.
autoLoginOptional
boolean. Do not prompt for authentication if the password is saved. Defaults to false.
ftpOptional
string. The address of the FTP proxy. Can include a port.
httpOptional
string. The address of the HTTP proxy. Can include a port.
httpProxyAllOptional
boolean. Use the HTTP proxy server for all protocols. Defaults to false.
passthroughOptional
string. A comma-separated list of hosts which should not be proxied. Defaults to "localhost, 127.0.0.1".
proxyDNSOptional
boolean. Proxy DNS when using SOCKS5. Defaults to false.
proxyTypeOptional
string. The type of proxy to use. This may take any one of the following values: "none", "autoDetect", "system", "manual", "autoConfig". Defaults to "system".
socksOptional
string. The address of the SOCKS proxy. Can include a port.
socksVersionOptional
integer. The version of the SOCKS proxy. May be 4 or 5. Defaults to 5.
sslOptional
string. The address of the SSL proxy. Can include a port.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome No support NoEdge No support NoFirefox Full support 60
Notes
Full support 60
Notes
Notes In version 59, this property was listed as proxyConfig in the browserSettings namespace, but had a bug that made it mostly unusable.
Opera No support NoFirefox Android No support No

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Examples

let proxySettings = {
  proxyType: "manual",
  http: "http://proxy.org:8080",
  socksVersion: 4,
  passthrough: ".example.org"
};

browser.proxy.settings.set({value: proxySettings});

Document Tags and Contributors

Contributors to this page: wbamberg
Last updated by: wbamberg,