https://github.com/httptoolkit/os-proxy-config

Access the operating system proxy configuration from Node.js, for all platforms
https://github.com/httptoolkit/os-proxy-config

linux mac os proxy windows

Last synced: 5 months ago
JSON representation

Access the operating system proxy configuration from Node.js, for all platforms

• Host: GitHub
• URL: https://github.com/httptoolkit/os-proxy-config
• Owner: httptoolkit
• License: apache-2.0
• Created: 2021-06-04T13:19:14.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-23T13:55:23.000Z (10 months ago)
• Last Synced: 2025-09-04T03:50:03.973Z (5 months ago)
• Topics: linux, mac, os, proxy, windows
• Language: TypeScript
• Homepage:
• Size: 44.9 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OS-Proxy-Config [![Build Status](https://github.com/httptoolkit/os-proxy-config/workflows/CI/badge.svg)](https://github.com/httptoolkit/os-proxy-config/actions) [![Available on NPM](https://img.shields.io/npm/v/os-proxy-config.svg)](https://npmjs.com/package/os-proxy-config)

> _Part of [HTTP Toolkit](https://httptoolkit.tech): powerful tools for building, testing & debugging HTTP(S)_

Access the operating system proxy configuration from Node.js, for all platforms. Use it like so:

```javascript

import { getSystemProxy } from 'os-proxy-config';

const proxy = await getSystemProxy();

```

The promise from `getSystemProxy` resolves to something like:

```json

{

    "proxyUrl": "https://proxy-server:123/",

    "noProxy": ["localhost", "example.com"]

}

```

The proxyUrl is returned in a format suitable for use with [proxy-agent](https://www.npmjs.com/package/proxy-agent): it might be an HTTP or HTTPS URL (for an HTTP proxy), a `socks://` or `socks5://` URL for SOCKS proxies, or a `pac+http://` URL (or similar) with the address of a PAC file for PAC-configured proxies.

If there's no proxy configured, it will resolve to `undefined` instead. If something major goes wrong and the settings can't be detected, the promise will be rejected.

This works slightly differently on each platform:

* On Windows it uses [windows-system-proxy](https://www.npmjs.com/package/windows-system-proxy), which reads proxy configuration from the registry using [registry-js](https://www.npmjs.com/package/registry-js).

* On Mac it uses [mac-system-proxy](https://github.com/httptoolkit/mac-system-proxy), which reads proxy configuration using the `scutil` command-line tool.

* On Linux it parses the various *_PROXY environment variables.

If you only need one platform, it's probably better to just use one of these approaches directly - this package is designed for use in cross-platform tools.