fbi-proxy 1.0.0

package/README.md

@@ -0,0 +1,158 @@
+# fbi-proxy
+
+FBI Proxy is a super easy way to turn your local network over https.
+
+## Quick Start
+
+```bash
+# Build the Rust proxy (production)
+npm run build-proxy
+
+# Start the proxy system
+npm start
+
+# Development mode with auto-reload
+npm run dev
+```
+
+## Build Scripts
+
+### Rust Proxy Build Commands:
+
+```bash
+# Production build (optimized)
+npm run build-proxy
+
+# Development build (faster compilation)
+npm run build-proxy-dev
+
+# Windows-specific build (uses build-windows.bat)
+npm run build-proxy-windows
+
+# Check code without building
+npm run check-proxy
+
+# Clean build artifacts
+npm run clean-proxy
+
+# Run tests
+npm run test-proxy
+
+# Format code
+npm run fmt-proxy
+
+# Run linter
+npm run clippy-proxy
+
+# Run proxy directly (for testing)
+npm run run-proxy
+```
+
+### Combined Commands:
+
+```bash
+# Build and run (development)
+npm run proxy:dev
+
+# Build and run (production)
+npm run proxy:prod
+
+# Full build (includes pre-build checks)
+npm run build
+```
+
+## Architecture
+
+- **TypeScript CLI** (`src/cli.ts`): Orchestrates Caddy and Rust proxy
+- **Rust Proxy** (`rs/proxy.rs`): High-performance HTTP/WebSocket proxy using Hyper
+- **Caddy Server**: Handles TLS termination and domain routing
+
+## Development Workflow
+
+### First Time Setup:
+
+```bash
+# 1. Install dependencies
+npm install
+
+# 2. Build the Rust proxy
+npm run build-proxy
+
+# 3. Start development
+npm run dev
+```
+
+### Daily Development:
+
+```bash
+# Quick development cycle
+npm run proxy:dev
+
+# Or step by step:
+npm run build-proxy-dev  # Fast Rust build
+npm run dev              # Start with auto-reload
+```
+
+### Before Committing:
+
+```bash
+npm run fmt-proxy        # Format Rust code
+npm run clippy-proxy     # Check Rust linting
+npm run check-proxy      # Verify compilation
+npm run test-proxy       # Run tests
+```
+
+### Production Build:
+
+```bash
+npm run build           # Full optimized build
+npm run proxy:prod      # Build and run production
+```
+
+## Prerequisites
+
+- **Rust**: Install from https://rustup.rs/
+- **Caddy**: Web server for TLS termination
+- **Bun**: Runtime for TypeScript CLI
+
+## feats
+
+1. Port Forwarder, https://[port].fbi.com proxies to http://localhost:[port]
+2. Host Forwarder, https://[*].[host].fbi.com proxies to [host] with url https://[*].fbi.com
+3. Host:Port forwarder https://[host]--[port].fbi.com proxies to http://[host]:[port]
+4. Configurable host alias
+
+## ...
+
+configurable local Proxy generator
+
+Environment Defaults:
+
+```env
+LOCALHOST="fbi.com"
+SERVICES="localhost:5600"
+```
+
+activitywatch=3000
+activitywatch=3000
+activitywatch=3000
+activitywatch=3000
+
+```
+
+# https://activitywatch.fbi.com -> localhost:5600
+activitywatch: :5600
+
+# https://aw.fbi.com -> localhost:5600
+aw: :5600
+
+# https://calibre.fbi.com -> localhost:7250
+calibre: :7250
+
+# https://everything.fbi.com -> localhost:2489
+everything: :2489
+
+# https://vscode.fbi.com -> localhost:8000
+vscode: :8000
+
+```

package/RUST_PROXY.md

@@ -0,0 +1,85 @@
+# Rust Proxy Migration
+
+The proxy functionality has been migrated from TypeScript/Bun to Rust for better performance and reliability.
+
+## Architecture
+
+- **TypeScript (`src/cli.ts`)**: Main entry point that:
+  - Checks for Rust and Caddy installation
+  - Launches the Rust proxy server
+  - Starts Caddy with the appropriate configuration
+- **Rust (`rs/proxy.rs`)**: High-performance proxy server that:
+  - Handles HTTP requests and WebSocket upgrades
+  - Processes host header port encoding (e.g., `example.com--3000` → `example.com:3000`)
+  - Forwards requests to local services
+  - Runs on port 24306
+
+## Building
+
+### Using npm/bun scripts:
+
+```bash
+# Build release version
+bun run build-proxy
+
+# Build development version
+bun run build-proxy-dev
+```
+
+### Manual build:
+
+```bash
+cd rs
+cargo build --release
+```
+
+### Platform-specific build scripts:
+
+```bash
+# Linux/macOS
+./build-proxy.sh
+
+# Windows
+build-proxy.bat
+```
+
+## Dependencies
+
+### System Requirements:
+
+- Rust (install from https://rustup.rs/)
+- Caddy web server
+- Bun runtime
+
+### Rust Dependencies:
+
+- `hyper` - HTTP server and client
+- `tokio` - Async runtime
+- `tokio-tungstenite` - WebSocket support
+- `futures-util` - Stream utilities
+- `url` - URL parsing
+- `regex` - Pattern matching
+
+## Features
+
+- **High Performance**: Native Rust implementation for better speed and memory usage
+- **WebSocket Support**: Full WebSocket proxying capabilities
+- **Port Encoding**: Supports special host header format for port specification
+- **Error Handling**: Robust error handling and logging
+- **Hot Reloading**: Development-friendly with auto-restart capabilities
+
+## Usage
+
+```bash
+# Start the full proxy system
+bun start
+
+# Development mode with hot reloading
+bun run dev
+```
+
+The proxy will:
+
+1. Start the Rust proxy server on port 24306
+2. Launch Caddy with the configured Caddyfile
+3. Handle all incoming requests and forward them to local services

package/build-proxy.bat

@@ -0,0 +1,15 @@
+@echo off
+
+REM Build script for the Rust proxy
+echo Building Rust proxy...
+
+cd rs
+cargo build --release
+
+if %errorlevel% equ 0 (
+    echo ✅ Rust proxy built successfully
+    echo Binary location: rs\target\release\proxy.exe
+) else (
+    echo ❌ Failed to build Rust proxy
+    exit /b 1
+)

package/build-proxy.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Build script for the Rust proxy
+echo "Building Rust proxy..."
+
+cd rs
+cargo build --release
+
+if [ $? -eq 0 ]; then
+    echo "✅ Rust proxy built successfully"
+    echo "Binary location: rs/target/release/proxy"
+else
+    echo "❌ Failed to build Rust proxy"
+    exit 1
+fi