Skip to content

Commit

Permalink
Merge pull request #315 from yawnt/options-doc
Browse files Browse the repository at this point in the history
 documentation for options
  • Loading branch information
blakmatrix committed Oct 15, 2012
2 parents 2e7d8a8 + 213e03c commit 1df2b30
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,34 @@ options:

If you have a suggestion for a feature currently not supported, feel free to open a [support issue][6]. node-http-proxy is designed to just proxy http requests from one server to another, but we will be soon releasing many other complimentary projects that can be used in conjunction with node-http-proxy.

## Options

### Http Proxy

`createServer()` supports the following options

```javascript
{
forward: { // options for forward-proxy
port: 8000,
host: 'staging.com'
},
target : { // options for proxy target
port : 8000,
host : 'localhost',
};
source : { // additional options for websocket proxying
host : 'localhost',
port : 8000,
https: true
},
enable : {
xforward: true // enables X-Forwarded-For
},
changeOrigin: false, // changes the origin of the host header to the target URL
}
```

## Run Tests
The test suite is designed to fully cover the combinatoric possibilities of HTTP and HTTPS proxying:

Expand Down

0 comments on commit 1df2b30

Please sign in to comment.