Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Simple proxy server built on express / connect.
JavaScript
branch: master

README.md

Proxit Build Status

Simple proxy server built on express / connect.

Installation

  1. npm install -g proxit (may need to add "sudo" for Mac / Linux)

Configuration - Stand Alone

  1. Create a configuration file in one of the following locations:

    • a local .proxitrc or the first found looking in ./ ../ ../../ ../../../ etc.
    • $HOME/.proxitrc
    • $HOME/.proxit/config
    • $HOME/.config/proxit
    • $HOME/.config/proxit/config
    • /etc/proxitrc
    • /etc/proxit/config
  2. Update the configuration file, e.g.:

    {
        "port": 9000,
        "verbose": true,
        "hosts": [{
            "hostnames": ["*"],
            "routes": {
                "/": "http://nodejs.org/"
            }
        },{
            "hostnames": ["local.mycompany.com"],
            "routes": {
                "/": "/code/local.mycompany.com/"
            }
        }]
    }
  3. Start proxit by running proxit on the command line.

Configuration - Grunt

In your project's gruntfile.js, add a section named proxit.

grunt.initConfig({
    proxit: {
        dev: {
            options: {
                verbose: true,
                hosts: [{
                    routes: {
                        '/': 'http://nodejs.org/'
                    }
                }]
            }
        }
    }
});

grunt.loadNpmTasks('proxit');

You can now start your dev configuration using grunt proxit:dev.

Configuration - Middleware (Connect / Express)

var proxit = require('proxit');

var config = {
    verbose: true,
    hosts: [{
        routes: {
            '/': 'http://nodejs.org/'
        }
    }]
};

express.use(proxit(config));

Issues / Bugs

https://github.com/cengage/proxit/issues

Something went wrong with that request. Please try again.