nport 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -45
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,67 +1,68 @@
1
- # **NPort**
1
+ # <img src="https://nport.link/assets/imgs/nport-logo.png" height="30" style="vertical-align: middle;"> NPort
2
2
 
3
- ## Overview
3
+ > A Node.js tool for exposing local servers through Socket.IO tunnels
4
4
 
5
5
  [![GitHub](https://img.shields.io/github/stars/tuanngocptn/nport?style=social)](https://github.com/tuanngocptn/nport)
6
6
  [![NPM](https://img.shields.io/npm/v/nport?color=red&logo=npm)](https://www.npmjs.com/package/nport)
7
7
  [![Website](https://img.shields.io/website?url=https%3A%2F%2Fnport.link&up_message=nport.link&up_color=blue&down_color=lightgrey&down_message=offline)](https://nport.link)
8
8
 
9
+ ## What is NPort?
9
10
 
10
- ![Logo][Logo]
11
- ![nport](https://github.com/user-attachments/assets/3f61ae7a-bff7-45d8-8f40-8e04b301a63a)
12
- NPort is a **Node.js-based tool** that tunnels HTTP connections through **Socket.IO** streams, enabling you to expose local servers via public URLs easily and securely. It is particularly useful for **development environments**, testing webhooks, and sharing projects on local servers.
11
+ [![nport](https://github.com/user-attachments/assets/6e188d75-4633-4efa-a7f4-63df6a4a7ac8)](https://nport.link)
13
12
 
14
- ---
13
+ NPort allows you to expose your local HTTP servers to the internet using Socket.IO streams. Perfect for:
14
+ - Development environments
15
+ - Testing webhooks
16
+ - Sharing local projects
15
17
 
16
- ## **Features**
18
+ ## ✨ Features
17
19
 
18
- - **HTTP Tunneling**: Expose your local HTTP server to the internet using Socket.IO-based tunnels.
19
- - **Secure and Lightweight**: A minimal, fast, and secure way to share your server without requiring complicated infrastructure.
20
- - **Custom Subdomains**: Access your local server using easy-to-read public URLs.
21
- - **WebSocket Support**: Handles WebSocket connections seamlessly.
22
- - **Cross-Platform**: Works on Linux, macOS, and Windows systems.
20
+ - 🔒 **Secure Tunneling**: Share your local server safely using Socket.IO
21
+ - 🚀 **Easy Setup**: Minimal configuration required
22
+ - 🌐 **Custom Domains**: Get readable URLs like `https://yourname.nport.link`
23
+ - 📡 **WebSocket Ready**: Full WebSocket connection support
24
+ - 💻 **Cross-Platform**: Runs on Windows, macOS, and Linux
23
25
 
24
- ---
26
+ ## 📦 Installation
25
27
 
26
- ## **Install**
28
+ **NPM Package**
29
+ ```bash
30
+ # Local installation
31
+ npm install nport
27
32
 
28
- ```sh
29
- # install nport from npm
30
-
31
- npm i nport # local install
32
-
33
- npm i -g nport # global install
34
-
35
- # alternative: install from github
33
+ # Global installation
34
+ npm install -g nport
35
+ ```
36
36
 
37
- npm install git+https://github.com/tuanngocptn/nport.git # local install
37
+ **From GitHub**
38
+ ```bash
39
+ # Local installation
40
+ npm install git+https://github.com/tuanngocptn/nport.git
38
41
 
39
- npm install -g git+https://github.com/tuanngocptn/nport.git # global install
42
+ # Global installation
43
+ npm install -g git+https://github.com/tuanngocptn/nport.git
40
44
  ```
41
45
 
42
- ---
43
-
44
- ## **How to use**
46
+ ## 🚀 Quick Start
45
47
 
46
- ```sh
47
- npx nport -s xxx -p 3000 # https://xxx.nport.link (local install)
48
+ ### Basic Usage
49
+ ```bash
50
+ # Local installation
51
+ npx nport -s myapp -p 3000
48
52
 
49
- nport -s xxx -p 3000 # https://xxx.nport.link (global install)
53
+ # Global installation
54
+ nport -s myapp -p 3000
50
55
  ```
51
- **OR**
52
-
53
- ```sh
54
- npx nport --server https://server.nport.link --subdomain xxx --hostname 127.0.0.1 --port 3000 # https://xxx.nport.link (local install)
55
-
56
- nport --server https://server.nport.link --subdomain xxx --hostname 127.0.0.1 --port 3000 # https://xxx.nport.link (global install)
56
+ This will create a tunnel at `https://myapp.nport.link`
57
+
58
+ ### Advanced Options
59
+ ```bash
60
+ # Full configuration
61
+ npx nport --server https://server.nport.link \
62
+ --subdomain myapp \
63
+ --hostname 127.0.0.1 \
64
+ --port 3000
57
65
  ```
58
66
 
59
- # Source from socket-tunnel
60
-
61
- Tunnel HTTP connections via socket.io streams. Inspired by [Socket Tunnel](https://github.com/ericbarch/socket-tunnel).
62
-
63
- ## Blog Post
64
-
65
- [Read all about it](https://ericbarch.com/post/sockettunnel/)
66
-
67
- [Logo]: https://img.shields.io/badge/🌶️_nport-FDC753?style=for-the-badge
67
+ ## 📝 Credits
68
+ Inspired by [Socket Tunnel](https://github.com/ericbarch/socket-tunnel). Read more about the concept in this [blog post](https://ericbarch.com/post/sockettunnel/).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nport",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "Tunnel HTTP Connections via socket.io streams.",
5
5
  "keywords": ["tunnel", "socket.io", "http", "streaming", "networking", "proxy"],
6
6
  "homepage": "https://nport.link",