https://github.com/donadev56/speed-tunnel-client
OpenNode is a tool designed to help developers publish their local servers on the internet. It utilizes Socket.IO for real-time communication between the client and server, and Fastify to handle HTTP requests. The client can register with the server, establish a unique subdomain, and receive HTTP requests via Socket.IO.
https://github.com/donadev56/speed-tunnel-client
Last synced: 2 months ago
JSON representation
OpenNode is a tool designed to help developers publish their local servers on the internet. It utilizes Socket.IO for real-time communication between the client and server, and Fastify to handle HTTP requests. The client can register with the server, establish a unique subdomain, and receive HTTP requests via Socket.IO.
- Host: GitHub
- URL: https://github.com/donadev56/speed-tunnel-client
- Owner: Donadev56
- Created: 2024-11-29T12:51:15.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-29T13:01:20.000Z (7 months ago)
- Last Synced: 2025-03-26T17:24:05.645Z (3 months ago)
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenNode Tunnel Client and Server
OpenNode is a tool designed to help developers publish their local servers on the internet. It utilizes Socket.IO for real-time communication between the client and server, and Fastify to handle HTTP requests. The client can register with the server, establish a unique subdomain, and receive HTTP requests via Socket.IO.
## Prerequisites
- Node.js
- npm
### installation
to install speed-tunnel-clientyou can run :
```
npm i -g speed-tunnel-client
```
### Usage
- Run the client with the following command:
```
speed-tunnel-client start -p -s
```
for example :
```
speed-tunnel-client start --port 5500 --subdomain pinky
```
Replace `` and `` with the desired values. If successful, the server will respond with the unique subdomain where the local server is accessible.
## Features
- **Socket.IO**: Creates a persistent connection between the client and server.
- **Fastify Integration**: Efficiently handles HTTP requests with high performance.
- **Custom Subdomains**: Each client can be assigned a unique subdomain.
- **Automatic Reconnection**: Supports reconnection in case of disconnection.
## 🚨 Warning
### Security Risks and Usage Conditions
- **Exposing Local Servers**: By using OpenNode, you are opening up a local server to the internet, which poses inherent security risks. Ensure that your local server has proper security configurations to prevent unauthorized access or data breaches.
- **Sensitive Data**: Avoid transmitting sensitive or personal data through the tunnel unless you are certain the data is encrypted and the application is secure.
- **Responsibility**: Users are responsible for securing their local environment and must be aware that any exposed service is potentially accessible by anyone with knowledge of the public URL.
- **Production Use**: This tool is primarily intended for development and testing purposes. Do **not** use it to expose production environments without thoroughly understanding the security implications.
- **IP Rate Limiting**: OpenNode does not inherently implement rate-limiting. You should implement your own rate-limiting mechanism if you expect to receive significant traffic to avoid unintended overloads or abuse.