hport-tunnel 1.0.0
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.
- package/LICENSE +15 -0
- package/README.md +55 -0
- package/dist/index.js +18 -0
- package/dist/package.json +3 -0
- package/hport.bat +45 -0
- package/hport.sh +46 -0
- package/package.json +35 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# H-PORT Personal Use License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 H-Lab Project
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, but **SUBJECT TO THE FOLLOWING CONDITIONS**:
|
|
10
|
+
|
|
11
|
+
1. **Non-Commercial Use Only**: The Software may only be used for personal, educational, or non-profit purposes. You may NOT use the Software for any commercial purpose, including but not limited to selling the software, using it within a commercial entity, or using it to provide paid services.
|
|
12
|
+
|
|
13
|
+
2. **Attribution**: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
3. **No Warranty**: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# ๐ H-PORT Tunnel
|
|
2
|
+
|
|
3
|
+
**H-PORT** is a powerful, lightweight localhost tunneling tool that creates secure HTTP/HTTPS connections from your local machine to the public internet using a custom domain (`hcu-lab.me`).
|
|
4
|
+
|
|
5
|
+
Perfect for sharing local development, testing webhooks, or mobile debugging without the hassle of server configuration.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## โจ Features
|
|
10
|
+
- ๐ก๏ธ **Secure Connections**: Automatic HTTPS via Cloudflare Edge.
|
|
11
|
+
- ๐ **Custom Subdomains**: Choose your own subdomain or get a random one.
|
|
12
|
+
- ๐งน **Auto-Cleanup**: Automatically releases DNS records and tunnels on exit.
|
|
13
|
+
- ๐ **Zero Config**: No complex setup required on the client side.
|
|
14
|
+
- ๐ฆ **Standalone Binary**: Packaged for high performance and portability.
|
|
15
|
+
|
|
16
|
+
## ๐ป Installation
|
|
17
|
+
|
|
18
|
+
### Prerequisites
|
|
19
|
+
- [Node.js](https://nodejs.org/) (v18 or higher)
|
|
20
|
+
- [cloudflared](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/installation/) installed on your system.
|
|
21
|
+
|
|
22
|
+
### Install via NPM
|
|
23
|
+
```bash
|
|
24
|
+
npm install -g hport
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## ๐ Quick Start
|
|
28
|
+
|
|
29
|
+
Expose your local port 8080:
|
|
30
|
+
```bash
|
|
31
|
+
hport 8080
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Expose with a custom subdomain:
|
|
35
|
+
```bash
|
|
36
|
+
hport 3000 -s myapp
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Expose a specific local IP:
|
|
40
|
+
```bash
|
|
41
|
+
hport 192.168.1.10:5000
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## ๐ ๏ธ Project Structure
|
|
45
|
+
- `/dist`: Optimized standalone build.
|
|
46
|
+
- `/server`: Backend logic running on Cloudflare Workers.
|
|
47
|
+
- `hport.sh / hport.bat`: Convenient interactive launchers for Linux and Windows.
|
|
48
|
+
|
|
49
|
+
## ๐ License
|
|
50
|
+
This project is licensed under the **H-PORT Personal Use License**.
|
|
51
|
+
- โ
Free for personal and educational use.
|
|
52
|
+
- โ **NOT** allowed for commercial use or resale.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
Created with โค๏ธ by H-Lab | Powered by Cloudflare
|