SamNet-dev/conduit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f4db8b859e8a07269606e59f17098d7ea3bafe52
conduit/README.md
Saman f4db8b859e Add rewards section to README 
Added rewards section with QR code instructions for claiming OAT tokens.
2026-01-29 10:45:38 -06:00

19 KiB
Raw Blame History

Conduit Manager

  ██████╗ ██████╗ ███╗   ██╗██████╗ ██╗   ██╗██╗████████╗
 ██╔════╝██╔═══██╗████╗  ██║██╔══██╗██║   ██║██║╚══██╔══╝
 ██║     ██║   ██║██╔██╗ ██║██║  ██║██║   ██║██║   ██║
 ██║     ██║   ██║██║╚██╗██║██║  ██║██║   ██║██║   ██║
 ╚██████╗╚██████╔╝██║ ╚████║██████╔╝╚██████╔╝██║   ██║
  ╚═════╝ ╚═════╝ ╚═╝  ╚═══╝╚═════╝  ╚═════╝ ╚═╝   ╚═╝
                      M A N A G E R

Version License Platform Docker Bash

A powerful management tool for deploying and managing Psiphon Conduit nodes on Linux servers. Help users access the open internet during network restrictions.

Quick Install

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

Or download and run manually:

wget https://raw.githubusercontent.com/SamNet-dev/conduit-manager/main/conduit.sh
sudo bash conduit.sh

What's New in v1.1

  • Multi-Container Support — Run up to 5 Conduit containers on a single server for higher throughput
  • Background Traffic Tracker — Continuous tcpdump-based tracker service with per-country GeoIP stats
  • Advanced Stats Page — Live dashboard with top countries by peers, download, upload, and unique IPs (bar charts, auto-refresh)
  • Live Dashboard Overhaul — Side-by-side active clients and top upload by country with real-time bars
  • Per-Container Settings — Configure max-clients and bandwidth individually for each container
  • Container Manager — Add or remove containers on the fly with auto-refreshing status view
  • Smart Install — Detects CPU cores and RAM, recommends container count for your hardware
  • Info & Help Hub — Multi-page guide covering the tracker, stats, containers, privacy, and about
  • Service Auto-Recovery — Automatically restarts failed conduit.service on script launch
  • Seamless Upgrade — Existing v1.0.x users can run the new script without reinstalling; old containers are recognized automatically

Features

  • One-Click Deployment — Automatically installs Docker and configures everything
  • Multi-Container Scaling — Run 1–5 containers to maximize your server's capacity
  • Multi-Distro Support — Works on Ubuntu, Debian, CentOS, Fedora, Arch, Alpine, openSUSE
  • Auto-Start on Boot — Supports systemd, OpenRC, and SysVinit
  • Live Dashboard — Real-time connection stats with CPU/RAM monitoring and per-country client breakdown
  • Advanced Stats — Top countries by connected peers, download, upload, and unique IPs with bar charts
  • Live Peer Traffic — Real-time traffic table by country with speed, total bytes, and IP/client counts
  • Background Tracker — Continuous traffic monitoring via systemd service with GeoIP resolution
  • Per-Container Settings — Configure max-clients and bandwidth per container
  • Easy Management — Powerful CLI commands or interactive menu
  • Backup & Restore — Backup and restore your node identity keys
  • Health Checks — Comprehensive diagnostics for troubleshooting
  • Info & Help — Built-in multi-page guide explaining how everything works
  • Complete Uninstall — Clean removal of all components

Supported Distributions

Family Distributions
Debian Ubuntu, Debian, Linux Mint, Pop!_OS, Kali, Raspbian
RHEL CentOS, Fedora, Rocky Linux, AlmaLinux, Amazon Linux
Arch Arch Linux, Manjaro, EndeavourOS
SUSE openSUSE Leap, openSUSE Tumbleweed
Alpine Alpine Linux

CLI Reference

After installation, use the conduit command:

Status & Monitoring

conduit status       # Show current status and resource usage
conduit stats        # View live statistics (real-time dashboard)
conduit logs         # View raw Docker logs
conduit health       # Run health check diagnostics
conduit peers        # Live peer traffic by country (GeoIP)

Rewards

conduit qr           # Show QR code to claim rewards via Ryve app

Container Management

conduit start        # Start all Conduit containers
conduit stop         # Stop all Conduit containers
conduit restart      # Restart all Conduit containers
conduit update       # Update to the latest Conduit image

Configuration

conduit settings     # Change max-clients and bandwidth per container
conduit menu         # Open interactive management menu

Backup & Restore

conduit backup       # Backup your node identity keys
conduit restore      # Restore node identity from backup

Maintenance

conduit uninstall    # Remove all components
conduit version      # Show version information
conduit help         # Show help message

Interactive Menu

The interactive menu (conduit menu) provides access to all features:

Option Description
1 View status dashboard — real-time stats with active clients and top upload by country
2 Live connection stats — streaming stats from Docker logs
3 View logs — raw Docker log output
4 Live peers by country — per-country traffic table with speed and client counts
5 Start Conduit
6 Stop Conduit
7 Restart Conduit
8 Update Conduit image
9 Settings & Tools — max-clients, bandwidth, QR code, backup, restore, health check, uninstall
c Manage containers — add or remove containers (up to 5)
a Advanced stats — top 5 charts for peers, download, upload, unique IPs
i Info & Help — multi-page guide with tracker, stats, containers, privacy, about
0 Exit

Configuration Options

Option Default Range Description
max-clients 200 1–1000 Maximum concurrent proxy clients per container
bandwidth 5 1–40, -1 Bandwidth limit per peer (Mbps). Use -1 for unlimited.

Recommended values based on server hardware:

CPU Cores RAM Recommended Containers Max Clients (per container)
1 Core < 1 GB 1 100
2 Cores 2 GB 1–2 200
4 Cores 4 GB+ 2–3 400
8+ Cores 8 GB+ 3–5 800

Installation Options

# Standard install
sudo bash conduit.sh

# Force reinstall
sudo bash conduit.sh --reinstall

# Uninstall everything
sudo bash conduit.sh --uninstall

# Show help
sudo bash conduit.sh --help

Upgrading from v1.0.x

Just run the new script. When prompted, select "Open management menu" — your existing container is recognized automatically. No reinstall needed. The background tracker service starts when you next start/restart from the menu.

Requirements

  • Linux server (any supported distribution)
  • Root/sudo access
  • Internet connection
  • Minimum 512MB RAM (1GB+ recommended for multi-container)

How It Works

  1. Detection — Identifies your Linux distribution and init system
  2. Docker Setup — Installs Docker if not present
  3. Hardware Check — Detects CPU/RAM and recommends container count
  4. Container Deployment — Pulls and runs the official Psiphon Conduit image
  5. Auto-Start Configuration — Sets up systemd/OpenRC/SysVinit service
  6. Tracker Service — Starts background traffic tracker with GeoIP resolution
  7. CLI Installation — Creates the conduit management command

Claim Rewards (OAT Tokens)

Conduit node operators can earn OAT tokens for contributing to the Psiphon network. To claim rewards:

  1. Install the Ryve app on your phone
  2. Create a crypto wallet within the app
  3. Link your Conduit containers by scanning the QR code:
    • From the menu: Option 6 → Show QR Code & Conduit ID
    • From Manage Containers: press [q] to display QR code
    • CLI: conduit qr
  4. Scan the QR code with the Ryve app to link your node
  5. Monitor & earn — the app shows your last 48 hours of connection activity and OAT token rewards

Each container has its own unique Conduit ID and QR code. If running multiple containers, you'll need to link each one separately.

Security

  • Secure Backups: Node identity keys are stored with restricted permissions (600)
  • No Telemetry: The manager collects no data and sends nothing externally
  • Local Tracking Only: Traffic stats are stored locally and never transmitted

راهنمای فارسی - مدیریت کاندوییت

ابزار قدرتمند برای راه‌اندازی و مدیریت نود سایفون کاندوییت روی سرورهای لینوکس. به کاربران کمک کنید تا در زمان محدودیت‌های اینترنتی به اینترنت آزاد دسترسی داشته باشند.

نصب سریع

دستور زیر را در ترمینال سرور اجرا کنید:

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

یا دانلود و اجرای دستی:

wget https://raw.githubusercontent.com/SamNet-dev/conduit-manager/main/conduit.sh
sudo bash conduit.sh

تازه‌های نسخه 1.1

  • پشتیبانی از چند کانتینر — اجرای تا ۵ کانتینر روی یک سرور برای ظرفیت بیشتر
  • ردیاب ترافیک پس‌زمینه — سرویس ردیابی مداوم با آمار جغرافیایی به تفکیک کشور
  • صفحه آمار پیشرفته — داشبورد زنده با نمودار میله‌ای برای برترین کشورها
  • داشبورد بازطراحی شده — نمایش کلاینت‌های فعال و آپلود برتر به تفکیک کشور
  • تنظیمات هر کانتینر — پیکربندی جداگانه حداکثر کاربران و پهنای باند
  • مدیریت کانتینرها — اضافه یا حذف کانتینر به صورت آنی
  • نصب هوشمند — تشخیص CPU و RAM و پیشنهاد تعداد کانتینر مناسب
  • بخش راهنما — راهنمای چندصفحه‌ای شامل ردیاب، آمار، کانتینرها، حریم خصوصی و درباره ما
  • بازیابی خودکار سرویس — ریستارت خودکار سرویس در صورت خرابی
  • ارتقا بدون نصب مجدد — کاربران نسخه قبلی بدون نیاز به نصب مجدد می‌توانند آپدیت کنند

ویژگی‌ها

  • نصب با یک کلیک — داکر و تمام موارد مورد نیاز به صورت خودکار نصب می‌شود
  • مقیاس‌پذیری چند کانتینره — اجرای ۱ تا ۵ کانتینر برای حداکثر استفاده از سرور
  • پشتیبانی از توزیع‌های مختلف — اوبونتو، دبیان، سنت‌اواس، فدورا، آرچ، آلپاین
  • راه‌اندازی خودکار — پس از ریستارت سرور، سرویس به صورت خودکار اجرا می‌شود
  • داشبورد زنده — نمایش لحظه‌ای وضعیت، تعداد کاربران، مصرف CPU و RAM
  • آمار پیشرفته — نمودار میله‌ای برترین کشورها بر اساس اتصال، دانلود، آپلود و IP
  • مانیتورینگ ترافیک — جدول لحظه‌ای ترافیک بر اساس کشور با سرعت و تعداد کلاینت
  • ردیاب پس‌زمینه — سرویس ردیابی مداوم ترافیک با تشخیص جغرافیایی
  • تنظیمات هر کانتینر — پیکربندی حداکثر کاربران و پهنای باند برای هر کانتینر
  • مدیریت آسان — دستورات قدرتمند CLI یا منوی تعاملی
  • پشتیبان‌گیری و بازیابی — پشتیبان‌گیری و بازیابی کلیدهای هویت نود
  • بررسی سلامت — تشخیص جامع برای عیب‌یابی
  • راهنما و اطلاعات — راهنمای چندصفحه‌ای داخلی
  • حذف کامل — پاکسازی تمام فایل‌ها و تنظیمات

دستورات CLI

وضعیت و مانیتورینگ

conduit status       # نمایش وضعیت و مصرف منابع
conduit stats        # داشبورد زنده (لحظه‌ای)
conduit logs         # لاگ‌های داکر
conduit health       # بررسی سلامت سیستم
conduit peers        # ترافیک بر اساس کشور (GeoIP)

پاداش

conduit qr           # نمایش QR کد برای دریافت پاداش از اپلیکیشن Ryve

مدیریت کانتینر

conduit start        # شروع تمام کانتینرها
conduit stop         # توقف تمام کانتینرها
conduit restart      # ریستارت تمام کانتینرها
conduit update       # به‌روزرسانی به آخرین نسخه

پیکربندی

conduit settings     # تغییر تنظیمات هر کانتینر
conduit menu         # منوی تعاملی

پشتیبان‌گیری و بازیابی

conduit backup       # پشتیبان‌گیری از کلیدهای نود
conduit restore      # بازیابی کلیدهای نود از پشتیبان

نگهداری

conduit uninstall    # حذف کامل
conduit version      # نمایش نسخه
conduit help         # راهنما

منوی تعاملی

گزینه توضیحات
1 داشبورد وضعیت — آمار لحظه‌ای با کلاینت‌های فعال و آپلود برتر
2 آمار زنده اتصال — استریم آمار از لاگ داکر
3 مشاهده لاگ — خروجی لاگ داکر
4 ترافیک زنده به تفکیک کشور — جدول ترافیک با سرعت و تعداد کلاینت
5 شروع کاندوییت
6 توقف کاندوییت
7 ریستارت کاندوییت
8 به‌روزرسانی ایمیج
9 تنظیمات و ابزارها — پهنای باند، QR کد، پشتیبان‌گیری، بازیابی، بررسی سلامت، حذف نصب
c مدیریت کانتینرها — اضافه یا حذف (تا ۵)
a آمار پیشرفته — نمودار برترین کشورها
i راهنما — توضیحات ردیاب، آمار، کانتینرها، حریم خصوصی
0 خروج

تنظیمات

گزینه پیش‌فرض محدوده توضیحات
max-clients 200 ۱–۱۰۰۰ حداکثر کاربران همزمان برای هر کانتینر
bandwidth 5 ۱–۴۰ یا ۱- محدودیت پهنای باند (Mbps). برای نامحدود ۱- وارد کنید.

مقادیر پیشنهادی بر اساس سخت‌افزار سرور:

پردازنده رم کانتینر پیشنهادی حداکثر کاربران (هر کانتینر)
۱ هسته کمتر از ۱ گیگ ۱ ۱۰۰
۲ هسته ۲ گیگ ۱–۲ ۲۰۰
۴ هسته ۴ گیگ+ ۲–۳ ۴۰۰
۸+ هسته ۸ گیگ+ ۳–۵ ۸۰۰

ارتقا از نسخه 1.0.x

فقط اسکریپت جدید را اجرا کنید. وقتی سوال پرسیده شد، گزینه «Open management menu» را انتخاب کنید. کانتینر موجود شما به صورت خودکار شناسایی می‌شود. نیازی به نصب مجدد نیست.

پیش‌نیازها

  • سرور لینوکس
  • دسترسی root یا sudo
  • اتصال اینترنت
  • حداقل ۵۱۲ مگابایت رم (۱ گیگ+ برای چند کانتینر پیشنهاد می‌شود)

نحوه عملکرد

  1. تشخیص — شناسایی توزیع لینوکس و سیستم init
  2. نصب داکر — در صورت نبود، داکر نصب می‌شود
  3. بررسی سخت‌افزار — تشخیص CPU و RAM و پیشنهاد تعداد کانتینر
  4. راه‌اندازی کانتینر — دانلود و اجرای ایمیج رسمی سایفون
  5. پیکربندی سرویس — تنظیم سرویس خودکار (systemd/OpenRC/SysVinit)
  6. سرویس ردیاب — شروع ردیاب ترافیک پس‌زمینه
  7. نصب CLI — ایجاد دستور مدیریت conduit

دریافت پاداش (توکن OAT)

اپراتورهای نود کاندوییت می‌توانند با مشارکت در شبکه سایفون توکن OAT کسب کنند. مراحل دریافت پاداش:

  1. اپلیکیشن Ryve را روی گوشی نصب کنید
  2. یک کیف پول کریپتو در اپلیکیشن بسازید
  3. کانتینرهای خود را لینک کنید با اسکن QR کد:
    • از منو: گزینه ۶ ← نمایش QR کد و شناسه کاندوییت
    • از مدیریت کانتینرها: کلید [q] را بزنید
    • CLI: conduit qr
  4. QR کد را اسکن کنید با اپلیکیشن Ryve تا نود شما لینک شود
  5. مانیتور و کسب درآمد — اپلیکیشن فعالیت ۴۸ ساعت اخیر و توکن‌های OAT را نمایش می‌دهد

هر کانتینر شناسه و QR کد منحصر به فرد خود را دارد. اگر چند کانتینر اجرا می‌کنید، باید هر کدام را جداگانه لینک کنید.

امنیت

  • پشتیبان‌گیری امن: کلیدهای هویت نود با دسترسی محدود (600) ذخیره می‌شوند
  • بدون تلمتری: هیچ داده‌ای جمع‌آوری یا ارسال نمی‌شود
  • ردیابی محلی: آمار ترافیک فقط به صورت محلی ذخیره شده و هرگز ارسال نمی‌شود

License

MIT License

Contributing

Pull requests welcome. For major changes, open an issue first.

Links

Reference in New Issue View Git Blame Copy Permalink