🐳 Wstunnel Docker Stack

This project contains a collection of Docker configurations and compose files for running wstunnel - a tool to tunnel traffic over WebSocket connections.

ℹ️ Note: This repository contains Docker configurations for wstunnel by Erebe - a fast and reliable WebSocket tunnel that supports TCP, UDP, and SOCKS5 proxying.

🧩 Components

🌐 Wstunnel Services

🖥️ Wstunnel Server

Server-side component that accepts WebSocket connections from clients and forwards traffic to target destinations. Supports multiple deployment environments including Let's Encrypt SSL and local CA certificates. Learn more about Wstunnel Server configuration.

💻 Wstunnel Client

Client-side component that creates WebSocket connections to the server and exposes local ports for SOCKS5, TCP, or UDP proxying. Learn more about Wstunnel Client configuration.

🔐 SSL Automation

🔒 Let's Encrypt Manager

Automatic SSL certificate management from Let's Encrypt for production deployments. Provides seamless HTTPS integration for Docker containers using nginx-proxy and acme-companion. Learn more about Let's Encrypt Manager configuration.

🏠 Step CA Manager

Local domain stack with trusted self-signed certificates for virtual network deployments. Includes private CA management and local DNS resolution for development environments. Learn more about Step CA Manager configuration.

🚀 Getting Started

To run the services, use the appropriate docker-compose.yml files in the subprojects. Make sure all environment variables are configured correctly.

Each service directory contains:

• 📋 Docker Compose configurations
• 🔧 Environment variable examples
• 📖 Detailed setup instructions
• 🛠️ Helper scripts for development and production

Quick Start Example

# Start wstunnel server (forwarding mode)
cd src/wstunnel-server/build/forwarding
cp .env.example .env
# Edit .env with your settings
docker compose up -d

# Start wstunnel client
cd src/wstunnel-client
cp .env.example .env
# Edit .env with your server address
docker compose up -d

🏗️ Project Structure

├── src/
│   ├── wstunnel-server/      # Wstunnel server configurations
│   ├── wstunnel-client/      # Wstunnel client configuration
│   └── ssl-automation/       # SSL certificate automation
│       ├── letsencrypt-manager/ # Let's Encrypt SSL certificate management
│       └── step-ca-manager/     # Local CA and trusted certificates

🔗 Related Projects

• wstunnel - Original wstunnel project by Erebe
• stackbuilder - Tool for building modular Docker Compose configurations

📄 License

This project is dual-licensed under:

• Apache License 2.0
• MIT License