Contributing

We love contributors! Your help is welcome to make this project better!

Some simple guidelines we'd like you to follow.

Got Questions or Problems?

If you have questions about http-proxy-middle usage; Please check if your question hasn't been already answered on Stack Overflow or in our issue archive, examples and recipes.

Since Nodejitsu's http-proxy is providing the actual proxy functionality; You might find your answer in their documentation, issue archive or examples.

Report Issues

If you think you've found an issue, please submit it to the Github issue tracker.

"It doesn't work" is not very useful for anyone. A good issue report should have a well described problem description and proxy configuration. A great issue report includes a minimal example.

Properly format your code example for easier reading: Code and Syntax Highlighting.

The quality of your issue report will determine how quickly and deeply we'll delve into it. Some simple pointers for reporting an issue:

Problem Description

describe the problem
steps taken (request urls)
found
expected

Configuration / Setup

http-proxy-middleware version
http-proxy-middleware configuration

It might be useful to provide server information in which http-proxy-middleware is used and the target server information to which requests are being proxied.

server + version (express, connect, browser-sync, etc...)
- server port number
target server
- target server port number

Minimal example

Provide a minimal example to exclude external factors. This will greatly help identifying the issue.

Tips on how to create a minimal example: http://stackoverflow.com/help/mcve

New Feature?

Request a new feature by submitting an issue into our Github issue tracker.

PRs are welcome. Please discuss it in our Github issue tracker before you start working on it, to avoid wasting your time and effort in case we are already (planning to) working on it.

Documentation

Feel free to send PRs to improve the documentation, examples and recipes.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!