Torware

One-click Tor Bridge/Relay node setup and management tool with live TUI dashboard, Snowflake proxy, Lantern Unbounded proxy, and Telegram notifications.

Screenshots

| Main Menu | Live Dashboard | Settings | |:---------:|:--------------:|:--------:| | | | |

Quick Install

curl -sL https://raw.githubusercontent.com/SamNet-dev/torware/main/torware.sh | sudo bash

That's it. The installer will:

• Detect your OS (Ubuntu, Debian, Fedora, CentOS, Arch, Alpine, etc.)
• Install Docker if not already present
• Walk you through an interactive setup wizard
• Start your Tor relay in Docker with auto-restart on boot

Features

Relay Types

• Bridge (obfs4) — Hidden entry point for censored users. IP not publicly listed. Safest option. (Default)
• Middle Relay — Routes encrypted traffic within the Tor network. IP is publicly listed but no exit traffic.
• Exit Relay — Final hop to the internet. Requires understanding of legal implications. Full warning and confirmation during setup.

Live TUI Dashboard

Real-time terminal dashboard with 5-second refresh:

• Active circuits and connections
• Bandwidth (download/upload) with totals
• CPU and RAM usage per container and system-wide
• Client countries (24-hour unique clients for bridges)
• Data cap usage (if configured)
• Snowflake proxy stats

Snowflake WebRTC Proxy

Run a Snowflake proxy alongside your relay to help censored users connect via WebRTC:

• No port forwarding needed (WebRTC handles NAT traversal)
• Configurable CPU and memory limits
• Live connection and traffic stats on the dashboard
• Independent start/stop from the main relay

Unbounded Proxy (Lantern)

Run Lantern's Unbounded volunteer WebRTC proxy to help censored users through a second circumvention network:

• Built from source automatically during setup
• Live and all-time connection tracking
• Independent management from the menu or CLI
• No port forwarding needed (WebRTC)

Multi-Container Support

Run up to 5 Tor containers simultaneously:

• Each container gets unique ORPort and ControlPort
• Per-container bandwidth, relay type, and resource limits
• Mixed relay types (e.g., container 1 = bridge, container 2 = middle)
• Add/remove containers from the management menu

MTProxy (Telegram Proxy)

Run an official Telegram proxy to help censored users access Telegram:

• FakeTLS obfuscation (traffic disguised as HTTPS)
• QR code and link generation for easy sharing
• Send proxy link directly via Telegram bot
• Configurable port, domain, CPU/memory limits
• Connection limits and geo-blocking options
• Host networking for reliable performance

Telegram Notifications

• Setup wizard with guided BotFather integration
• Periodic status reports (configurable interval + start hour)
• Bot commands: /tor_status, /tor_peers, /tor_uptime, /tor_containers, /tor_snowflake, /tor_unbounded, /tor_mtproxy, /tor_start_N, /tor_stop_N, /tor_restart_N, /tor_help
• Send MTProxy link & QR code via bot
• Alerts for high CPU, high RAM, all containers down, or zero connections
• Daily and weekly summary reports
• Uses /tor_ prefix so the bot can be shared with other services

Background Traffic Tracker

• ControlPort event subscription for real-time bandwidth and circuit data
• Country-level traffic aggregation via GeoIP
• Cumulative statistics persisted to disk
• Runs as a systemd service (or OpenRC/SysVinit)

Health Check

15-point diagnostic covering:

• Docker daemon status
• Container state and restart count
• ControlPort connectivity and cookie authentication
• Data volume integrity
• Network mode verification
• Relay fingerprint validation
• Snowflake proxy and metrics endpoint
• GeoIP and system tool availability

About & Learn

Built-in educational section covering:

• What is Tor and how it works
• Bridge, Middle, and Exit relay explanations
• Snowflake proxy details
• How Tor circuits work (with ASCII diagram)
• Dashboard metrics explained
• Legal and safety considerations
• Port forwarding guide for home users

CLI Commands

torware start           Start all relay containers
torware stop            Stop all relay containers
torware restart         Restart all relay containers
torware status          Show relay status summary
torware dashboard       Open live TUI dashboard
torware stats           Open advanced statistics
torware peers           Show live peers by country
torware logs            View container logs
torware health          Run health check
torware fingerprint     Show relay fingerprint(s)
torware bridge-line     Show bridge line(s) for sharing
torware snowflake       Snowflake proxy management
torware unbounded       Unbounded proxy status
torware mtproxy         MTProxy (Telegram) status and link
torware backup          Backup Tor identity keys
torware restore         Restore from backup
torware uninstall       Remove Torware and containers
torware menu            Open interactive menu
torware help            Show help
torware version         Show version

Or just run torware with no arguments to open the interactive menu.

Requirements

• OS: Linux (Ubuntu, Debian, Fedora, CentOS, RHEL, Arch, Alpine, openSUSE, Raspbian)
• RAM: 512 MB minimum (1 GB+ recommended for multiple containers)
• Docker: Installed automatically if not present
• Ports: 9001 TCP (ORPort), 9002 TCP (obfs4) — must be forwarded if behind NAT
• Root: Required for Docker and system service management

Port Forwarding (Home Users)

If running from home behind a router, you must forward these ports:

| Port | Protocol | Purpose | |------|----------|---------| | 9001 | TCP | Tor ORPort | | 9002 | TCP | obfs4 pluggable transport |

Log into your router (usually 192.168.1.1 or 10.0.0.1), find Port Forwarding, and add both TCP forwards to your server's local IP.

Snowflake does not need port forwarding — WebRTC handles NAT traversal automatically.

Docker Images

| Relay Type | Image | |------------|-------| | Bridge (obfs4) | thetorproject/obfs4-bridge:0.24 | | Middle/Exit Relay | osminogin/tor-simple:0.4.8.10 | | Snowflake Proxy | thetorproject/snowflake-proxy:latest | | Unbounded Proxy | torware/unbounded-widget:latest (built from source) | | MTProxy (Telegram) | nineseconds/mtg:2.1.7 |

File Structure

/opt/torware/
├── settings.conf              # Configuration
├── torware                    # Management script (symlinked to /usr/local/bin/torware)
├── torware-tracker.sh         # Background ControlPort monitor
├── backups/                   # Tor identity key backups
├── relay_stats/               # Tracker data
│   ├── cumulative_data        # Country|InBytes|OutBytes
│   ├── cumulative_ips         # Country|IP
│   ├── tracker_snapshot       # Real-time 15s window
│   └── geoip_cache            # IP to Country cache
└── containers/                # Per-container torrc files
    ├── relay-1/torrc
    ├── relay-2/torrc
    └── ...

Configuration

All settings are stored in /opt/torware/settings.conf and can be changed via the Settings menu or by editing the file directly.

Key settings:

• RELAY_TYPE — bridge, middle, or exit
• NICKNAME — your relay's nickname on the Tor network
• CONTACT_EMAIL — contact for directory authorities
• BANDWIDTH — bandwidth rate limit (Mbit/s)
• CONTAINER_COUNT — number of Tor containers (1-5)
• DATA_CAP — monthly data cap (GB), 0 for unlimited
• SNOWFLAKE_ENABLED — true/false
• SNOWFLAKE_CPUS / SNOWFLAKE_MEMORY — Snowflake resource limits
• UNBOUNDED_ENABLED — true/false
• UNBOUNDED_CPUS / UNBOUNDED_MEMORY — Unbounded resource limits
• MTPROXY_ENABLED — true/false
• MTPROXY_PORT — Telegram proxy port (default: 8443)
• MTPROXY_DOMAIN — FakeTLS domain (default: cloudflare.com)
• MTPROXY_CPUS / MTPROXY_MEMORY — MTProxy resource limits

Per-container overrides: RELAY_TYPE_N, BANDWIDTH_N, ORPORT_N (where N is the container index).

Uninstall

sudo torware uninstall

This will stop and remove containers, remove systemd services, and optionally delete configuration and backups.

Contributing

Contributions are welcome. Please open an issue or pull request on GitHub.

License

This project is licensed under the MIT License. See LICENSE for details.

Changelog

v1.1 — Feature Patch

• MTProxy (Telegram Proxy) — Run an official Telegram proxy to help censored users access Telegram
  • FakeTLS obfuscation (traffic looks like HTTPS to cloudflare.com, google.com, etc.)
  • Host networking mode for reliable DNS resolution
  • Prometheus metrics for accurate traffic monitoring
  • QR code generation for easy sharing
  • Telegram bot integration: send proxy link & QR via /tor_mtproxy command
  • Menu option to send link via Telegram after setup or changes
  • Port change warnings (alerts when proxy URL changes)
  • Security settings: connection limits, geo-blocking by country
  • CLI command: torware mtproxy
  • Setup wizard integration (standalone or as add-on)
• Lantern Unbounded Proxy — Run Lantern's Unbounded volunteer WebRTC proxy alongside your relay to help censored users access the internet through a second censorship-circumvention network
  • Built from source during Docker image creation (pinned to production-compatible commit)
  • Live and all-time connection tracking on the dashboard
  • Full menu management: start, stop, restart, disable, change resources, remove
  • Telegram bot command: /tor_unbounded
  • CLI command: torware unbounded
  • Health check integration
  • Setup wizard integration (standalone or as add-on to any relay type)
  • About & Learn se