🚀 Shifter Toolkit

A production-ready toolkit for provisioning and operating secure network tunnels on Linux hosts.

✨ Features

• 🎯 Unified Control Plane - Install, inspect, and remove tunnelling services
• 💻 CLI Interface - Colorful status output and command groups per service
• 🌐 Web Dashboard - AIOHTTP + Jinja2 powered dashboard
• 📦 Packaged Templates - Reproducible deployments without network fetches
• 📚 PyPI Ready - Complete packaging with entry points and documentation

📋 Requirements

• 🐧 Linux host with systemd and iptables
• 🐍 Python 3.9+ (CPython recommended)
• 🔐 Root/sudo privileges for system services and firewall rules

🚀 Installation

📦 Stable Release

pip install shifter-toolkit

🔧 From Source

git clone https://github.com/zZedix/Shifter.git
cd Shifter
pip install -e .

⚡ Quick Start

# 📋 Review available commands
sudo shifter-toolkit --help

# 🌐 Launch the web dashboard (http://127.0.0.1:2063 by default)
sudo shifter-toolkit serve --host 0.0.0.0 --port 2063

# 🔍 Inspect the health of all managed services
sudo shifter-toolkit status

⚠️ Note: Each sub-command validates that it is executed with root privileges before touching the system.

📚 Command Reference

Run sudo shifter-toolkit <group> --help for all arguments on a specific command family.

🌐 Web Dashboard

Shifter ships with a lightweight dashboard that mirrors the CLI capabilities.

• 📁 Templates live inside the package (shifter/web/templates) so deployments don't rely on external assets
• 🔐 Sessions are backed by encrypted cookies
• 🔑 Set AIOHTTP_SECRET_KEY in the environment to supply a persistent key across restarts

📦 Packaged Templates

Installer commands render configuration templates that are bundled with the package:

• 🔧 gost.service for systemd
• ⚙️ haproxy.cfg with placeholder tokens
• 📄 config.json base configuration for Xray

Use importlib.resources helpers in shifter.services.config if you need custom automation that reuses these bundled files.

🛠️ Development

# 📦 Install runtime dependencies
pip install -r requirements.txt

# 🔧 Install the project in editable mode
pip install -e .

# 🚀 Optional: run the CLI locally
sudo python -m shifter status

We recommend developing inside a virtual environment to isolate dependencies.

📖 Documentation

Extended guides are available under docs/, covering deployment patterns, CLI details, and release workflows.

📄 License

Shifter Toolkit is released under the MIT License.

Made with ❤️ by zZedix