Node.js global proxy setting

Question

I was working in a corporate network behind a proxy server. In my code I can set the proxy by using the approach mentioned in this thread.

But the problem is that most of the 3rd party modules do not have proxy setting and I cannot modify their code to add the proxy. Also, my code might be used in a direct connection environment which means I cannot hard-code my proxy setting in code.

I know NPM has a global setting for proxy which is

npm config set proxy http://proxy.company.com:8080
npm config set https-proxy http://proxy.company.com:8080

But I didn't find any config similar in Node.js.

Does Node.js support global proxy setting so that I don't need to change all codes and switch on and off easily?

As of Node.js v12, you can use github.com/gajus/global-agent. — Gajus
– Gajus, Commented Apr 25, 2019 at 15:15

Luke · Accepted Answer · 2019-06-13 05:34:59Z

35

Unfortunately, it seems that proxy information must be set on each call to http.request. Node does not include a mechanism for global proxy settings.

The global-tunnel-ng module on NPM appears to handle this, however:

var globalTunnel = require('global-tunnel-ng');

globalTunnel.initialize({
  host: '10.0.0.10',
  port: 8080,
  proxyAuth: 'userId:password', // optional authentication
  sockets: 50 // optional pool size for each http and https
});

After the global settings are establish with a call to initialize, both http.request and the request library will use the proxy information.

The module can also use the http_proxy environment variable:

process.env.http_proxy = 'http://proxy.example.com:3129';
globalTunnel.initialize();

edited Jun 13, 2019 at 5:34

Luke

3062 silver badges7 bronze badges

answered Jan 7, 2015 at 18:02

apsillers

117k18 gold badges248 silver badges249 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Michael McLaughlin Over a year ago

so there is a global mechanism for proxy settings? because that's basically what the env.http_proxy is, no?

Anirudh Jayakumar Over a year ago

Can username and password be specified in the global tunnel configuration?

Mu Mind Jan 20 at 16:39

@MichaelMcLaughlin not globally for Node, the conventional http_proxy env variable is only supported indirectly via global-tunnel-ng mechanisms to override behavior for an individual Node process.

Mu Mind Jan 20 at 16:41

@AnirudhJayakumar yes, the conventional http_proxy env variable supported by tools like curl accepts a "user:pwd@" prefix: oxylabs.io/blog/curl-with-proxy#using-environment-variables. global-tunnel-ng should respect username/password specified there too.

Zheng Bowen · Accepted Answer · 2020-06-03 14:10:44Z

11

You can try my package node-global-proxy which work with all node versions and most of http-client (axios, got, superagent, request etc.)

after install by

npm install node-global-proxy --save

a global proxy can start by

const proxy = require("node-global-proxy").default;

proxy.setConfig({
  http: "http://localhost:1080",
  https: "https://localhost:1080",
});
proxy.start();

/** Proxy working now! */

More information available here: https://github.com/wwwzbwcom/node-global-proxy

answered Jun 3, 2020 at 14:10

Zheng Bowen

4193 silver badges8 bronze badges

7 Comments

Berstigma Over a year ago

Is this good to retrieve the URLs I visit in my browser?

izogfif Over a year ago

"https://localhost:1080" yields error. Says must start with http://.

shivshankar Over a year ago

@izogfif facing same issue any solution ?

izogfif Over a year ago

@shivshankar It's been a long time ago, but I somehow managed to make it work. According to package-lock.json, the working version was 1.0.1. The working index.js has these lines:

const proxy = require("node-global-proxy").default; proxy.setConfig({http: "http://localhost:8888", https: "http://localhost:8888"}); proxy.start();

Shahyad Sharghi Over a year ago

I managed to make it work. unfortunately, it doesn't have any proxy bypass option. so I had to revert back

|

Undo · Accepted Answer · 2018-03-11 21:21:13Z

4

I finally created a module to get this question (partially) resolved. Basically this module rewrites http.request function, added the proxy setting then fire. Check my blog post: https://web.archive.org/web/20160110023732/http://blog.shaunxu.me:80/archive/2013/09/05/semi-global-proxy-setting-for-node.js.aspx

edited Mar 11, 2018 at 21:21

Undo♦

25.7k38 gold badges114 silver badges132 bronze badges

answered Dec 12, 2013 at 3:22

Shaun Xu

4,6762 gold badges34 silver badges44 bronze badges

3 Comments

yuyue007 Over a year ago

Great solution, I am using a third part middleware, it will make http request, how to resolve proxy issue in this scenario?

Shaun Xu Over a year ago

I think the code in my blog can solve your problem if the 3rd party module utilizes http module to send request. Just ensure you require my module before the 3rd party one.

haxpor Over a year ago

Url return 404, I found this one geekswithblogs.net/shaunxu/archive/2013/09/05/…

Megh Parikh · Accepted Answer · 2017-07-27 15:49:01Z

3

While not a Nodejs setting, I suggest you use proxychains which I find rather convenient. It is probably available in your package manager.

After setting the proxy in the config file (/etc/proxychains.conf for me), you can run proxychains npm start or proxychains4 npm start (i.e. proxychains [command_to_proxy_transparently]) and all your requests will be proxied automatically.

Config settings for me:

These are the minimal settings you will have to append

## Exclude all localhost connections (dbs and stuff)
localnet 0.0.0.0/0.0.0.0
## Set the proxy type, ip and port here
http    10.4.20.103 8080

(You can get the ip of the proxy by using nslookup [proxyurl])

answered Jul 27, 2017 at 15:49

Megh Parikh

9642 gold badges8 silver badges25 bronze badges

Comments

Tung Vo · Accepted Answer · 2024-04-16 02:32:21Z

-2

In my case, I go to folder C:\Users\my-username and edit file .npmrc.

proxy=http://my-username:my-password@proxy-host:proxy-port
http-proxy=http://my-username:my-password@proxy-host:proxy-port
https-proxy=http://my-username:my-password@proxy-host:proxy-port

Everything work ok

answered Apr 16, 2024 at 2:32

Tung Vo

2,5876 gold badges31 silver badges48 bronze badges

Comments

vijay · Accepted Answer · 2019-04-02 12:37:15Z

-7

replace {userid} and {password} with your id and password in your organization or login to your machine.

npm config set proxy http://{userid}:{password}@proxyip:8080/
npm config set https-proxy http://{userid}:{password}@proxyip:8080/
npm config set http-proxy http://{userid}:{password}@proxyip:8080/
strict-ssl=false

answered Apr 2, 2019 at 12:37

vijay

6437 silver badges9 bronze badges

2 Comments

Fred Danna Over a year ago

Note that {userid} and {password} need to be URL-encoded, if they contain meta-characters (like "/", ":", "@", ...)

Amit Naidu Over a year ago

This is already addressed in the question. This question is about a node.js proxy, not an npm proxy.

Collectives™ on Stack Overflow

Node.js global proxy setting

6 Answers 6

4 Comments

7 Comments

3 Comments

Comments

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

4 Comments

7 Comments

3 Comments

Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related