English | 简体中文

NodePass is an open-source, lightweight, enterprise-grade TCP/UDP network tunneling solution featuring an all-in-one architecture with separation of control and data channels, along with flexible and high-performance instance control. It supports zero-configuration deployment, intelligent connection pooling, tiered TLS encryption, and seamless protocol conversion. Designed for DevOps professionals and system administrators to effortlessly handle complex network scenarios.

💎 Key Features

• 🌐 Universal Functionality

  • Basic TCP/UDP tunneling and protocol conversion across diverse networks.
  • Compatible with port mapping, NAT traversal, and traffic relay.
  • Cross-platform, multi-architecture, single binary or container.

• 🚀 Connection Pool

  • Pre-established connections for zero-latency switching and forwarding.
  • Eliminates handshake delays, boosts performance.
  • Auto-scaling with real-time capacity adjustment.

• 🧬 Innovative Architecture

  • Integrated S/C/M architecture, flexible mode switching.
  • Full decoupling of control/data channels.
  • API-instance management, multi-instance collaboration.

• 🔐 Multi-level Security

  • Three TLS modes: plaintext, self-signed, strict validation.
  • Covers development to enterprise security needs.
  • Hot-reload certificates with zero downtime.

• ⚙️ Minimal Configuration

  • No config files required, ready to use via CLI.
  • Optimized for CI/CD and containers.
  • Flexible tuning via environment variables.

• 📈 Performance

  • Intelligent scheduling, auto-tuning, ultra-low resource usage.
  • Stable under high concurrency and heavy load.
  • Health checks, auto-reconnect, self-healing.

• 💡 Visualization

  • Rich cross-platform visual frontends.
  • One-click deployment scripts, easy management.
  • Real-time monitoring, API-instance management, traffic stats.

📋 Quick Start

📥 Installation

• Pre-built Binaries: Download from releases page.
• Container Image: docker pull ghcr.io/yosebyte/nodepass:latest

🚀 Basic Usage

Server Mode

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

Client Mode

nodepass "client://server:10101/127.0.0.1:8080?min=128"

Master Mode (API)

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

📚 Documentation

Explore the complete documentation to learn more about NodePass:

• Installation Guide
• Usage Instructions
• Configuration Options
• API Reference
• Examples
• How It Works
• Troubleshooting

🌱 Ecosystem

The NodePassProject organization develops various frontend applications and auxiliary tools to enhance the NodePass experience:

• NodePassDash: A modern NodePass management interface that provides master management, instance management, traffic statistics, history records, and more.

• NodePanel: A lightweight frontend panel that provides visual tunnel management, deployable on Vercel or Cloudflare Pages.

• npsh: A collection of one-click scripts that provide simple deployment for API or Dashboard with flexible configuration and management.

💬 Discussion

• Follow our Telegram Channel for updates and community support.

• Join our Discord and Telegram Group to share experiences and ideas.

📄 License

Project NodePass is licensed under the BSD 3-Clause License.

⚖️ Disclaimer

This project is provided "as is" without any warranties. Users assume all risks and must comply with local laws for legal use only. Developers are not liable for any direct, indirect, incidental, or consequential damages. Secondary development requires commitment to legal use and self-responsibility for legal compliance. Developers reserve the right to modify software features and this disclaimer at any time. Final interpretation rights belong to developers.

🤝 Sponsors

⭐ Stargazers