Skip to content
/ Smite Public

Modern tunnel management built on GOST, Backhaul, FRP, Chisel and Rathole, featuring an intuitive WebUI, fast CLI, and open-source freedom.

License

Notifications You must be signed in to change notification settings

zZedix/Smite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Smite - Tunneling Control Panel

Smite Logo

Modern tunnel management built on GOST, Backhaul, Rathole, Chisel, and FRP, featuring an intuitive WebUI, fast CLI, and open-source freedom.

License: MIT Python FastAPI React TypeScript Docker Nginx SQLite


πŸš€ Features

  • Multiple Tunnel Types: Support for TCP, UDP, gRPC, TCPMux, Backhaul, Rathole, Chisel, and FRP
  • Docker-First: Easy deployment with Docker Compose
  • Web UI: Modern, intuitive web interface for tunnel management
  • CLI Tools: Powerful command-line tools for management
  • Node Support: Easy reverse tunnel setup with Backhaul, Rathole, Chisel, and FRP nodes
  • GOST Forwarding: Direct forwarding without nodes for better performance

πŸ“‹ Prerequisites

  • Docker and Docker Compose installed
  • For Iran servers, install Docker first:
    curl -fsSL https://raw.githubusercontent.com/manageitir/docker/main/install-ubuntu.sh | sh

πŸ”§ Panel Installation

Quick Install

sudo bash -c "$(curl -sL https://raw.githubusercontent.com/zZedix/Smite/main/scripts/install.sh)"

Manual Install

  1. Clone the repository:
git clone https://github.com/zZedix/Smite.git
cd Smite
  1. Copy environment file and configure:
cp .env.example .env
# Edit .env with your settings

Tip: To free ports 80/443 for tunnels, set SMITE_HTTP_PORT and SMITE_HTTPS_PORT in .env. Nginx will render its configuration from nginx/default.conf.template using these values.

  1. Install CLI tools:
sudo bash cli/install_cli.sh
  1. Start services:
docker compose up -d
  1. Create admin user:
smite admin create
  1. Access the web interface at http://localhost:8000

πŸ–₯️ Node Installation

Note: Nodes are used for Backhaul, Rathole, Chisel, and FRP tunnels, providing easy reverse tunnel functionality. For GOST tunnels (TCP, UDP, gRPC, TCPMux), you can forward directly without a node.

Quick Install

sudo bash -c "$(curl -sL https://raw.githubusercontent.com/zZedix/Smite/main/scripts/smite-node.sh)"

The installer will prompt for:

  • Panel CA certificate path
  • Panel address (host:port)
  • Node API port (default: 8888)
  • Node name (default: node-1)

Manual Install

  1. Navigate to node directory:
cd node
  1. Copy Panel CA certificate:
mkdir -p certs
cp /path/to/panel/ca.crt certs/ca.crt
  1. Create .env file:
cat > .env << EOF
NODE_API_PORT=8888
NODE_NAME=node-1
PANEL_CA_PATH=/etc/smite-node/certs/ca.crt
PANEL_ADDRESS=panel.example.com:443
EOF
  1. Start node:
docker compose up -d

πŸ› οΈ CLI Tools

Panel CLI (smite)

Admin Management:

smite admin create      # Create admin user
smite admin update      # Update admin password

Panel Management:

smite status            # Show system status
smite update            # Update panel (pull images and recreate)
smite restart           # Restart panel (recreate to pick up .env changes)
smite logs              # View panel logs

Configuration:

smite edit              # Edit docker-compose.yml
smite edit-env          # Edit .env file

Node CLI (smite-node)

Node Management:

smite-node status       # Show node status
smite-node update       # Update node (pull images and recreate)
smite-node restart      # Restart node (recreate to pick up .env changes)
smite-node logs         # View node logs

Configuration:

smite-node edit         # Edit docker-compose.yml
smite-node edit-env     # Edit .env file

πŸ“– Tunnel Types

GOST Tunnels (Direct Forwarding)

  • TCP: Simple TCP forwarding
  • UDP: UDP packet forwarding
  • gRPC: gRPC protocol forwarding
  • TCPMux: TCP multiplexing for multiple connections

These tunnels work directly without requiring a node - they forward traffic from the panel to the target server.

Backhaul Tunnels (Reverse Tunnel)

  • TCP / UDP: Low-latency reverse tunnels with optional UDP-over-TCP
  • WS / WSMux: WebSocket transports for CDN-friendly deployments
  • Advanced Controls: Configure multiplexing, keepalive, sniffer, and custom port maps per tunnel

Backhaul tunnels require a node. The panel manages the Backhaul server automatically and the node applies the matching client configuration.

Rathole Tunnels (Reverse Tunnel)

Rathole tunnels require a node and provide easy reverse tunnel functionality. The node connects to the panel, allowing you to expose services running on the node's network through the panel.

Chisel Tunnels (Reverse Tunnel)

Chisel tunnels require a node and provide fast TCP/UDP reverse tunnel functionality. Similar to Rathole, the node connects to the panel's Chisel server, enabling you to expose services running on the node's network through the panel with high performance.

FRP Tunnels (Reverse Tunnel)

FRP (Fast Reverse Proxy) tunnels require a node and provide reliable TCP/UDP reverse tunnel functionality. The panel manages the FRP server automatically, and the node runs the FRP client to establish the reverse tunnel connection. FRP supports both TCP and UDP protocols, with optional IPv6 support for tunneling IPv6 traffic over IPv4 networks.


πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.


πŸ’° Donations

If you find Smite useful and want to support its development, consider making a donation:

Cryptocurrency Donations

  • Bitcoin (BTC): bc1q637gahjssmv9g3903j88tn6uyy0w2pwuvsp5k0
  • Ethereum (ETH): 0x5B2eE8970E3B233F79D8c765E75f0705278098a0
  • Tron (TRX): TSAsosG9oHMAjAr3JxPQStj32uAgAUmMp3
  • USDT (BEP20): 0x5B2eE8970E3B233F79D8c765E75f0705278098a0
  • TON: UQA-95WAUn_8pig7rsA9mqnuM5juEswKONSlu-jkbUBUhku6

Other Ways to Support

  • ⭐ Star the repository if you find it useful
  • πŸ› Report bugs and suggest improvements
  • πŸ“– Improve documentation and translations
  • πŸ”— Share with others who might benefit

Made with ❀️ by zZedix

Securing the digital world, one line of code at a time!

About

Modern tunnel management built on GOST, Backhaul, FRP, Chisel and Rathole, featuring an intuitive WebUI, fast CLI, and open-source freedom.

Topics

Resources

License

Stars

Watchers

Forks

Packages