Skip to main content

中文

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.

Metadata

Release files for proxynt 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for proxynt 2.1.1
File Size Uploaded Provenance Actions
proxynt-2.1.1.tar.gz 510.1 kB Without provenance Details for proxynt-2.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for proxynt 2.1.1
File Interpreter ABI Platform Actions
proxynt-2.1.1-py3-none-any.whl Python 3 none any Details for proxynt-2.1.1-py3-none-any.whl

Total release size: 1.1 MB

Release files / proxynt-2.1.1.tar.gz

Download URL proxynt-2.1.1.tar.gz
Size 510.1 kB
Tags Source
SHA-256 checksum
How to use checksums
1e558e1b5ec897ae979d2de969ab0a0ed26a9cd83649b7aa7a91b884320b16b3
BLAKE2b-256 checksum
How to use checksums
6b9c0820657cbdd8accaa4d7f7663289ccd2b4b5de82a55bbca94d161a4cea46
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.9

Release files / proxynt-2.1.1-py3-none-any.whl

Download URL proxynt-2.1.1-py3-none-any.whl
Size 583.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
558426e0fa10759aad53ca45170d2ad508fd6c544b912c700f79a289397e1111
BLAKE2b-256 checksum
How to use checksums
8ef2f5ca4af9840034f664586de8e8634c815a71f8e84967e800f3cd2ad34537
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.9

Security for proxynt 2.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page