# proxy-tunnel

> Proxy all http and https requests through a tunnel

Latest version **0.1.1** (published 2015-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install proxy-tunnel
pnpm add proxy-tunnel
yarn add proxy-tunnel
bun add proxy-tunnel
```

Provides the command `proxy-tunnel`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-01-26 |
| First published | 2014-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Author | Montana Flynn |
| Maintainers | montanaflynn |
| Keywords | proxy, tunnel, http, https, api, analytics |

## Links

- npm: https://www.npmjs.com/package/proxy-tunnel
- npm.io page: https://npm.io/package/proxy-tunnel

## Dependencies (6)

- [qs](https://npm.io/package/qs.md) ^2.3.3
- [zmq](https://npm.io/package/zmq.md) ^2.9.0
- [meow](https://npm.io/package/meow.md) ^2.0.0
- [es6-promise](https://npm.io/package/es6-promise.md) ^2.0.1
- [stream-meter](https://npm.io/package/stream-meter.md) ^1.0.3
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^1.2.1

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2015-01-26
- 0.1.0 — 2015-01-26
- 0.0.11 — 2015-01-26
- 0.0.10 — 2015-01-21
- 0.0.9 — 2015-01-21
- 0.0.8 — 2015-01-20
- 0.0.7 — 2015-01-20
- 0.0.6 — 2015-01-20
- 0.0.5 — 2015-01-20
- 0.0.4 — 2015-01-20
- 0.0.3 — 2014-11-25
- 0.0.2 — 2014-11-24

## README

# proxy-tunnel

Proxy all http and https requests through a tunnel and optionally sends data to APIanalytics.com.

![Screencast of the proxy](https://i.imgur.com/1IztvqA.gif)

### Usage

```sh
sudo npm install proxy-tunnel -g
```

```
  Usage
    $ tunnel-proxy [options]

    options:
     -p          change proxy port number (default: 3000)
     -s          change max sockets (default: 300)
     -h          change target url header name (default: target)
     -q          stay quiet, don't console log (default: false)
     -v          verbose mode logs har output (default: false)
     -k          apianalytics.com api key (optional)
     -t          apianalytics.com transport layer (optional options: "socket.io", "zeromq" default: "socket.io")
     --help      output usage and help information
     --version   output the current version of tunnel-proxy

    examples:
     tunnel-proxy -h "baseurl"
     tunnel-proxy -q -p 8080
     tunnel-proxy -t "zeromq" -k "54adbfffeba3f94b5182carr"
```

#### Programatic

```sh
npm install proxy-tunnel --save
```

```js
var proxy = require("proxy-tunnel")
proxy({
  port: 8080,        // default: 3000
  quiet: true,       // default: false
  header: "baseurl"  // default: "target"
})
```

### Uses

- Get around CORS
- Log requests / responses
- Block requests / responses
- Transform requests / responses
- Much more I can't think of

### Todos

- Add testing framework
- Add various options
- Custom middleware???

### Contributing

Forks and pull requests are most welcomed.

### MIT license

Copyright (c) 2014, Montana Flynn (http://anonfunction.com/)

---
_Source: https://npm.io/package/proxy-tunnel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
