راهنمای استفاده از برنامه

برای استفاده از این برنامه، لازم است به پنل Virtualizor سرور مجازی خود دسترسی داشته باشید. این پنل ممکن است در وب‌سایت ارائه‌دهنده خدمات، با عنوان Enduser Panel معرفی شده باشد.

دریافت API Key و API Password

از طریق پنل Virtualizor، یک API Key و API Password ایجاد نمایید. توصیه می‌شود حتماً آدرس IP سروری که قصد اجرای این اسکریپت را دارید در پنل وایت‌لیست کنید. در غیر این صورت، هر فردی با هر IP می‌تواند به سرور شما دسترسی پیدا کند.

---

مراحل نصب

1. دانلود پروژه

ابتدا اسکریپت را از مخزن گیت‌هاب دانلود کرده و وارد پوشه پروژه شوید:

git clone https://github.com/Danialslm/traffic-notifier.git && cd traffic-notifier

2. کپی فایل‌های نمونه پیکربندی

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

cp servers.json.sample servers.json
cp .env.sample .env

---

پیکربندی فایل‌ها

فایل servers.json

این فایل را با ویرایشگر دلخواه خود باز کرده و مقادیر آن را مطابق نیاز تنظیم کنید:

• name: یک نام دلخواه برای سرور.
• url: لینک دریافت اطلاعات از سرور مجازی در پنل Virtualizor.

نمونه‌ای از محتوای فایل:

[
  {
    "name": "ایران ۱",
    "url": "https://example.com:4083/sess6ICCoygYmavNA358/index.php?act=vpsmanage&svs=85&api=json&apikey=<api key>&apipass=<api password>"
  },
  {
    "name": "ایران ۲",
    "url": "https://example.com:4083/sess6ICCoygYmavNA358/index.php?act=vpsmanage&svs=371&api=json&apikey=<api key>&apipass=<api password>"
  }
]

---

فایل .env

این فایل را با مقادیر دلخواه به‌صورت زیر ویرایش کنید:

# توکن ربات تلگرام
BOT_TOKEN=

# شناسه چتی که ربات باید نوتیفیکیشن را به آن ارسال کند
CHAT_ID=

# آستانه‌های هشدار در صورت کاهش درصد باقی‌مانده ترافیک
NOTIFY_TRAFFIC_PERCENTS=10,5,1

# فاصله زمانی اجرای برنامه (بر حسب دقیقه)
INTERVAL_MINUTES=5

در صورتی که با سرور خارجی به پنل virtualizor ارتباط نمیگیرید، میتونید یه پروکسی http با ایپی ایران ست کنید. (با پنل xui میتونید راحت بسازید)
توجه داشته باشید در صورت ست کردن پروکسی، باید آیپی پروکسی رو به عنوان وایت لیست api key و api password پنل virtualizor در نظر بگیرید!
PROXY=http://your.proxy:port

---

اجرای برنامه

برای اجرای برنامه با استفاده از Docker و مشاهده لاگ‌ها، دستور زیر را اجرا کنید:

docker compose up -d && docker compose logs -f

---

پیشنهادات و بازخورد

از دریافت نظرات و پیشنهادات شما استقبال می‌کنیم 💫

---