https://github.com/zicklag/tuxy

Super small node TCP/UDP proxy
https://github.com/zicklag/tuxy

Last synced: about 1 year ago
JSON representation

Super small node TCP/UDP proxy

• Host: GitHub
• URL: https://github.com/zicklag/tuxy
• Owner: zicklag
• License: mit
• Created: 2018-01-10T21:15:13.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-04-06T02:01:58.000Z (about 4 years ago)
• Last Synced: 2025-02-28T03:26:49.835Z (over 1 year ago)
• Language: JavaScript
• Size: 24.4 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Tuxy

[![NPM version](https://img.shields.io/npm/v/tuxy.svg?style=flat)](https://npmjs.com/package/tuxy) [![NPM downloads](https://img.shields.io/npm/dm/tuxy.svg?style=flat)](https://npmjs.com/package/tuxy)

Tuxy is a super small command line TCP and UDP proxy. It can be installed through yarn or npm.

```bash

npm install -g tuxy

# OR

yarn global add tuxy

```

## Usage

Tuxy is configured with a simple JSON string either from a file or passed in directly on the command line.

Each proxy record must have `type`, `in_port`, `target_port`, and `target_host` properties. The `name` property is optional and will be used in logging output if specified.

### Config File

```bash

tuxy -f myProxies.json

```

#### myProxies.json

```JSON

{

  "proxies": [

    {

      "name": "HTTP proxy",

      "type": "tcp",

      "in_port": 8080,

      "target_port": 80,

      "target_host": "targetHTTPServer"

    },

    {

      "type": "tcp",

      "in_port": 5000,

      "target_port": 8000,

      "target_host": "someserver"

    },

    {

      "name": "other proxy",

      "type": "udp",

      "in_port": 5001,

      "target_port": 3000,

      "target_host": "anotherserver.com"

    }

  ]

}

```

### Command Line

When passing in the proxies on the command line you do not put the proxies key in the JSON string. You just pass in the proxies array.

```bash

tuxy --proxies '[{"type": "tcp", "in_port": 80, "target_port": 80, "target_host": "example.org"}]'

```