opentunnel-cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FJRG2007
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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

@@ -0,0 +1,284 @@
+# OpenTunnel
+
+Self-hosted alternative to ngrok. Expose local services to the internet with custom subdomains.
+
+## Installation
+
+### NPM (Recommended - All OS)
+
+```bash
+# Install globally
+npm install -g opentunnel-cli
+
+# Verify installation
+opentunnel --version
+```
+
+### NPX (No installation)
+
+```bash
+npx opentunnel-cli up
+```
+
+### From Source
+
+```bash
+git clone https://github.com/FJRG2007/opentunnel.git
+cd opentunnel
+npm install
+npm run build
+npm link  # Makes 'opentunnel' available globally
+```
+
+### Update
+
+```bash
+npm update -g opentunnel-cli
+```
+
+---
+
+## Usage
+
+### Main commands
+
+```bash
+opentunnel up      # Start server and tunnels
+opentunnel down    # Stop everything
+opentunnel init    # Create opentunnel.yml config file
+```
+
+---
+
+## Deployment Types
+
+### 1. On a VPS/Server
+
+Typical production use. The server runs on a VPS with a public IP and configured domain.
+
+**Requirements:**
+- VPS with public IP
+- Domain pointing to the VPS (e.g., `*.op.yourdomain.com`)
+- Port 443 open
+
+**DNS Configuration:**
+```
+Type    Name    Content/Value     Proxy status (Cloudflare only)
+ A      *.op    <VPS_IP_ADDRESS>  DNS only
+ A      op      <VPS_IP_ADDRESS>  DNS only
+```
+
+**opentunnel.yml on the VPS:**
+```yaml
+version: "1.0"
+
+server:
+  port: 443
+  domain: yourdomain.com
+  basePath: op
+
+tunnels: []  # VPS only runs the server
+```
+
+**On your local machine:**
+```yaml
+version: "1.0"
+
+server:
+  url: wss://op.yourdomain.com/_tunnel  # Connect to VPS
+
+tunnels:
+  - name: web
+    protocol: http
+    port: 3000
+    subdomain: web
+```
+
+```bash
+# On the VPS
+opentunnel up
+
+# On your local machine
+opentunnel up
+```
+
+Result: `https://web.op.yourdomain.com` -> `localhost:3000`
+
+---
+
+### 2. At Home (Domestic Use)
+
+Run the server on your own local network. Requires router configuration.
+
+**Requirements:**
+- Domain pointing to your public IP (can be dynamic with DuckDNS)
+- Configure port forwarding on your router
+
+**DNS Configuration:**
+```
+Type    Name    Content/Value       Proxy status (Cloudflare only)
+ A      *.op    <YOUR_PUBLIC_IP>    DNS only
+ A      op      <YOUR_PUBLIC_IP>    DNS only
+```
+
+If you have a dynamic IP, use DuckDNS:
+```
+Type    Name    Content/Value
+ A      *.op    yoursubdomain.duckdns.org (auto-updated)
+ A      op      yoursubdomain.duckdns.org (auto-updated)
+```
+
+**Router Configuration (Port Forwarding):**
+
+| Name | Protocol | WAN Port | LAN Port | LAN IP |
+|------|----------|----------|----------|--------|
+| OpenTunnel HTTPS | TCP | 443 | 443 | 192.168.1.X |
+| OpenTunnel TCP | TCP | 10000-20000 | 10000-20000 | 192.168.1.X |
+
+> Replace `192.168.1.X` with your machine's local IP address.
+
+**opentunnel.yml:**
+```yaml
+version: "1.0"
+
+server:
+  port: 443
+  domain: yourdomain.com  # or yoursubdomain.duckdns.org
+  basePath: op
+
+tunnels:
+  - name: web
+    protocol: http
+    port: 3000
+    subdomain: web
+    autostart: true
+
+  - name: api
+    protocol: http
+    port: 4000
+    subdomain: api
+    autostart: true
+```
+
+```bash
+opentunnel up
+```
+
+Result:
+- `https://web.op.yourdomain.com` -> `localhost:3000`
+- `https://api.op.yourdomain.com` -> `localhost:4000`
+
+---
+
+## Full Configuration
+
+**opentunnel.yml:**
+```yaml
+version: "1.0"
+
+server:
+  port: 443              # Server port (default: 443)
+  domain: yourdomain.com # Base domain
+  basePath: op           # Subdomain prefix (default: op)
+  https: true            # Enable HTTPS (default: true)
+  tcpPortMin: 10000      # Minimum TCP port (default: 10000)
+  tcpPortMax: 20000      # Maximum TCP port (default: 20000)
+  token: secret          # Authentication token (optional)
+
+  # To connect to a remote server:
+  # url: wss://server.com/_tunnel
+
+tunnels:
+  # HTTP Tunnel
+  - name: web
+    protocol: http
+    port: 3000
+    subdomain: web
+    host: localhost      # (default: localhost)
+    autostart: true      # (default: true)
+
+  # TCP Tunnel (databases, etc.)
+  - name: postgres
+    protocol: tcp
+    port: 5432
+    remotePort: 15432    # Public TCP port
+    autostart: false
+```
+
+---
+
+## Additional Commands
+
+```bash
+# Quick HTTP tunnel (without yml file)
+opentunnel http 3000 --subdomain web --domain yourdomain.com
+
+# TCP tunnel
+opentunnel tcp 5432 --remote-port 15432 --domain yourdomain.com
+
+# Start in background
+opentunnel up -d
+
+# View status
+opentunnel ps
+
+# Stop everything
+opentunnel down
+
+# Initialize configuration file
+opentunnel init
+```
+
+---
+
+## Architecture
+
+```
+                    INTERNET
+                        |
+                        v
++--------------------------------------------------+
+|                    ROUTER                         |
+|  Port Forward: 443 -> 192.168.1.X:443            |
++--------------------------------------------------+
+                        |
+                        v
++--------------------------------------------------+
+|             YOUR MACHINE (192.168.1.X)           |
+|                                                   |
+|   +-------------------------------------------+  |
+|   |            OpenTunnel Server              |  |
+|   |              (port 443)                   |  |
+|   +-------------------------------------------+  |
+|          |                    |                  |
+|          v                    v                  |
+|   +------------+       +------------+            |
+|   | Web App    |       | API        |            |
+|   | :3000      |       | :4000      |            |
+|   +------------+       +------------+            |
++--------------------------------------------------+
+
+Access from internet:
+  https://web.op.yourdomain.com -> localhost:3000
+  https://api.op.yourdomain.com -> localhost:4000
+```
+
+---
+
+## SSL Certificates
+
+OpenTunnel generates SSL certificates automatically:
+
+- **Self-signed** (default): Works but browser shows warning
+- **Let's Encrypt**: Valid certificates (requires port 80)
+
+```bash
+# Use Let's Encrypt
+opentunnel server --letsencrypt --email your@email.com
+```
+
+---
+
+## License
+
+MIT

package/dist/cli/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":""}