Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.07 KB

README.md

File metadata and controls

68 lines (51 loc) · 2.07 KB

NPort

A Node.js tool for exposing local servers through Socket.IO tunnels

GitHub NPM Website

What is NPort?

nport

NPort allows you to expose your local HTTP servers to the internet using Socket.IO streams. Perfect for:

  • Development environments
  • Testing webhooks
  • Sharing local projects

✨ Features

  • 🔒 Secure Tunneling: Share your local server safely using Socket.IO
  • 🚀 Easy Setup: Minimal configuration required
  • 🌐 Custom Domains: Get readable URLs like https://yourname.nport.link
  • 📡 WebSocket Ready: Full WebSocket connection support
  • 💻 Cross-Platform: Runs on Windows, macOS, and Linux

📦 Installation

NPM Package

# Local installation
npm install nport

# Global installation
npm install -g nport

From GitHub

# Local installation
npm install git+https://github.com/tuanngocptn/nport.git

# Global installation
npm install -g git+https://github.com/tuanngocptn/nport.git

🚀 Quick Start

Basic Usage

# Local installation
npx nport -s myapp -p 3000

# Global installation
nport -s myapp -p 3000

This will create a tunnel at https://myapp.nport.link

Advanced Options

# Full configuration
npx nport --server https://server.nport.link \
         --subdomain myapp \
         --hostname 127.0.0.1 \
         --port 3000

📝 Credits

Inspired by Socket Tunnel. Read more about the concept in this blog post.