Skip to main content

No project description provided

Project description

中文

ProxyNT is a reverse proxy server that can expose a local server to the internet through NATs and firewalls

原理

Features

  1. Open port mapping via browser anytime and anywhere
  2. Encrypted transmission between public network server and local network client via WebSocket
  3. Few dependencies, one-click installation via pip
  4. Stable, automatically reconnect, and already in production environment
  5. Support for rate limiting

Common Scenarios

  1. Hosting website server at home
  2. Managing IoT devices

Installation

pip install -U proxynt

Example: Accessing an Internal Network Machine via SSH

Suppose the public server's IP is 192.168.9.224.

1. Create config_s.json file on the public network machine

config_s.json content:

{
  "port": 18888,
  "password": "helloworld",
  "path": "/websocket_path",
  "admin": {
    "enable": true,  
    "admin_password": "new_password"  
  }
}

Then start: nt_server -c config_s.json

Explanation:

  • port: Listening port
  • password: Connection password
  • path: WebSocket path
  • admin: Management page configuration (optional)
  • admin.enable: Whether to enable management page
  • admin.admin_password: Management password

2. Create config_c.json file on the local network computer that needs to be accessed

config_c.json content:

{
  "server": {
    "url": "ws://192.168.9.224:18888/websocket_path",
    "password": "helloworld"
  },
  "client_name": "home_pc"
}

Then start: nt_client -c config_c.json

Explanation:

  • server: Configuration of the server to be connected, including port, IP address, whether to use HTTPS, password, and WebSocket path.
  • client_name: Client name, needs to be unique.
  • client: Empty array.

3. Open the server webpage http://192.168.9.224:18888/websocket_path/admin and add a port:

VWCvq.md.png

Explanation: The management page path is WebSocket path + /admin .

4. Configuration succeeded, use SSH to connect:

ssh -oPort=12222 test@192.168.9.224

Complete Configuration Instructions (please delete the comments when using)

  • Client config_c.json
{
  "server": {  // Server configuration to connect to
    "port": 18888,  // Port
    "host": "192.168.9.224",  // IP address
    "https": false,  // Whether the server is using HTTPS
    "password": "helloworld",  // Password
    "path": "/websocket_path"  // WebSocket path
  },
  "client": [  // List of forwarding configurations
    {
      "name": "ssh",
      "remote_port": 1222,
      "local_port": 22,
      "local_ip": "127.0.0.1"
    },
    {
      "name": "mongo",
      "remote_port": 1223,
      "local_port": 27017,
      "local_ip": "127.0.0.1"
    }
  ],
  "client_name": "ubuntu1",  // Client name, must be unique
  "log_file": "/var/log/nt/nt.log"  // Path to log file
}
  • Server config_c.json
{
    "port": 18888,  // Listening port
    "password": "helloworld",  // Password
    "path": "/websocket_path",  // WebSocket path
    "log_file": "/var/log/nt/nt.log",  // Path to log file
    "admin": {  
        "enable": true,  // Whether to enable admin page
        "admin_password": "new_password"  // Password for admin page
    }
}

Stargazers over time

Stargazers over time

Update history

  • 1.1.9: Bandwidth limitation
  • 1.1.8: Display client version
  • 1.1.7: Fixed duplicate client_name
  • 1.1.6: Fixed client WebSocketException: socket is already opened.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proxynt-1.1.33.tar.gz (344.6 kB view details)

Uploaded Source

Built Distribution

proxynt-1.1.33-py3-none-any.whl (370.1 kB view details)

Uploaded Python 3

File details

Details for the file proxynt-1.1.33.tar.gz.

File metadata

  • Download URL: proxynt-1.1.33.tar.gz
  • Upload date:
  • Size: 344.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.14

File hashes

Hashes for proxynt-1.1.33.tar.gz
Algorithm Hash digest
SHA256 661a2b8b85e19d349c3f55bcc1748bf630d4d77d6278bfc7fa0ae64efee2fe99
MD5 6c92f158e9f839405bd96177bedfb5a8
BLAKE2b-256 dd75148ef9888e447887633d82c57a3959427f5bafaee2d8800a8377a1b67e59

See more details on using hashes here.

File details

Details for the file proxynt-1.1.33-py3-none-any.whl.

File metadata

  • Download URL: proxynt-1.1.33-py3-none-any.whl
  • Upload date:
  • Size: 370.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.14

File hashes

Hashes for proxynt-1.1.33-py3-none-any.whl
Algorithm Hash digest
SHA256 6268f2d5a67c5163c309f49d83569f3beb9985c4e37bdb847857029017b4cc80
MD5 84ff670774f6e95ecc703acc5cbb13a1
BLAKE2b-256 36a84add1364f8a3947fb0b2090f3b79f4c4969058853c40c46aff49fd917581

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page