Skip to content

Fix proxy config docs #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 9, 2014
Merged

Fix proxy config docs #436

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab2eafa
Revise proxy configuration docs
AdityaManohar Dec 8, 2014
fb6f804
Revise proxy configuration docs
AdityaManohar Dec 9, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions doc-src/guide/node-configuring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,15 +238,23 @@ AWS.config.apiVersion = '2012-05-04';
### Configuring a Proxy

If you cannot connect to the internet directly, the SDK supports the use of
HTTP or HTTPS proxies through global or per-service configuration options. To
set a proxy, pass the `proxy` option to the `httpOptions` setting of your
config object. This is how you could set a global proxy:
HTTP or HTTPS proxies through the use of a third party HTTP agent such as
[proxy-agent](https://github.com/TooTallNate/node-proxy-agent). You can visit
[npmjs.org](http://npmjs.org) for a list of other proxy libraries.

##### Installation

```javascript
npm install proxy-agent --save
```

##### In your code

```javascript
var proxy = require('proxy-agent');

AWS.config.update({
httpOptions: {
proxy: 'http://localhost:8080'
}
httpOptions: { agent: proxy('http://internal.proxy.com') }
});

var s3 = new AWS.S3();
Expand Down