Skip to main content

Web3 Pi tunnel - a basic tcp reverse tunnel

Project description

WEb3Pi Tunnel

PoC Python implementation of a basic TCP tunnel. Primary purpose: provide a public IP to clients behind NATs.

It was initially developed alongside the Web3Pi Proxy.

Setup

Simply install web3pi-tunnel package using your Python package manager, using pip for example:

pip install web3pi-tunnel

Configuration

Provide .env file or set the system environments with the following entries.

Client

  • TUNNEL_SERVICE_HOST - the network address of the tunnel server
  • CLIENT_SERVICE_HOST - the network address of the client target service
  • CLIENT_SERVICE_PORT - the port of the client target service
  • TUNNEL_ESTABLISH_PORT - the port of the tunnel server
  • TUNNEL_SERVICE_AUTH_KEY - the api key to authenticate at the tunnel server

Server

  • SERVICE_PUBLIC_IP - the network address of the tunnel server
  • SERVICE_PUBLIC_LISTEN_PORT - the port of tunnel server for external web3 users
  • TUNNEL_ESTABLISH_PORT - the port of the tunnel server for the tunnel client
  • PROXY_ESTABLISH_PORT - the port of the tunnel server for stats
  • TUNNEL_SERVICE_AUTH_KEY - the api key to authenticate the tunnel client

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

web3pi_tunnel-0.1a2.tar.gz (21.8 kB view hashes)

Uploaded Source

Built Distribution

web3pi_tunnel-0.1a2-py3-none-any.whl (29.0 kB view hashes)

Uploaded Python 3

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