Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 4.75 KB

README.md

File metadata and controls

104 lines (75 loc) · 4.75 KB
nodepass

GitHub release GitHub downloads Go Report Card GitHub last commit

English | 简体中文

NodePass is an universal, lightweight TCP/UDP tunneling solution. Built on an innovative three-tier architecture (server-client-master), it elegantly separates control and data channels while offering intuitive zero-configuration syntax. The system excels with its proactive connection pool that eliminates latency by establishing connections before they're needed, alongside flexible security through tiered TLS options and optimized data transfer handling. One of its most distinctive features is seamless protocol translation between TCP and UDP, enabling applications to communicate across networks with protocol constraints. It adapts intelligently to network fluctuations, ensuring reliable performance even in challenging environments while maintaining efficient resource utilization. From navigating firewalls and NATs to bridging complex proxy configurations, it provides DevOps professionals and system administrators with a solution that balances sophisticated capabilities with remarkable ease of use.

💎 Key Features

  • 🔀 Multiple Operating Modes

    • Server mode accepting incoming tunnels with configurable security
    • Client mode for establishing outbound connections to tunnel servers
    • Master mode with RESTful API for dynamic instance management

  • 🌍 Protocol Support

    • TCP tunneling with persistent connection handling
    • UDP datagram forwarding with configurable buffer sizes
    • Intelligent routing mechanisms for both protocols

  • 🛡️ Security Options

    • TLS Mode 0: Unencrypted mode for maximum speed in trusted networks
    • TLS Mode 1: Self-signed certificates for quick secure setup
    • TLS Mode 2: Custom certificate validation for enterprise security

  • ⚡ Performance Features

    • Smart connection pooling with real-time capacity adaptation
    • Dynamic interval adjustment based on network conditions
    • Minimal resource footprint even under heavy load
    • Automatic recovery from network disruptions

  • 🧰 Simple Configuration

    • Zero configuration files required
    • Simple command-line parameters
    • Environment variables for fine-tuning performance
    • Intelligent defaults for most use cases

📋 Quick Start

📥 Installation

  • Pre-built Binaries: Download from releases page.
  • Go Install: go install github.com/yosebyte/nodepass/cmd/nodepass@latest
  • Container Image: docker pull ghcr.io/yosebyte/nodepass:latest
  • Management Script: bash <(curl -sL https://cdn.yobc.de/shell/nodepass.sh)

🚀 Basic Usage

Server Mode

nodepass "server://:10101/127.0.0.1:8080?log=debug&tls=1"

Client Mode

nodepass client://server.example.com:10101/127.0.0.1:8080

Master Mode (API)

nodepass "master://:10101/api?log=debug&tls=1"

🔧 Common Use Cases

  • Remote Access: Securely access internal services from external locations
  • Firewall Bypass: Navigate through restrictive network environments
  • Secure Microservices: Establish encrypted channels between distributed components
  • Database Protection: Enable secure database access while keeping servers isolated
  • IoT Communication: Connect devices across different network segments
  • Penetration Testing: Create secure tunnels for security assessments

📚 Documentation

Explore the complete documentation to learn more about NodePass:

👥 Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

💬 Discussion

Join our discussions to share your experiences and ideas.

📄 License

Project NodePass is licensed under the MIT LICENSE.

⭐ Stargazers

Stargazers over time