NX Notif

از NX · notif

رسمی

به کاربرانتان دربارهٔ حسابشان خبر می‌دهد — انقضا و ترافیک، تمدید، و پیام‌های خودتان به یک کاربر یا گروه — با تلگرام، بله، پیامک، ایمیل یا هر API، از اولین راهی که به کاربر برسد.

نصب

دستی

روی سروری که افزونه قرار است رویش باشد، با کاربر root اجرا کنید:

به‌صورت سرویس (بدون Docker)

curl -fsSL https://raw.githubusercontent.com/nx-panel/notif/v0.4.1/install.sh -o install.sh
sh install.sh --method script --version v0.4.1 \
  --opt port=8097 \
  --opt database=sqlite \
  --opt admin_username=admin \
  --opt admin_password=<admin_password> \
  --opt https=panel \
  --panel-url https://<your-panel>

با Docker

curl -fsSL https://raw.githubusercontent.com/nx-panel/notif/v0.4.1/install.sh -o install.sh
sh install.sh --method docker --version v0.4.1 \
  --opt port=8097 \
  --opt database=sqlite \
  --opt admin_username=admin \
  --opt admin_password=<admin_password> \
  --opt https=panel \
  --panel-url https://<your-panel>

بعد در پنل به افزونه‌ها ← ثبت افزونهٔ امضاشده بروید و آدرس افزونه و کد ادعایی را که نشان می‌دهد وارد کنید.

گزینه‌های نصب

گزینه	نوع	پیش‌فرض
پورت Notif روی این پورت گوش می‌دهد. با HTTPS روشن فقط همین پورت HTTPS می‌دهد و آدرس عمومی همین پورت را دارد (برای acme ۴۴۳). `NX_OPT_PORT`	`port`	`8097`
مسیر ادمین ادمین نوتیف، API آن و درخواست‌های پنل همه زیر این مسیرند؛ ریشه جوابی نمی‌دهد. خالی: ریشه. `NX_OPT_BASE_PATH`	`path`	`—`
دیتابیس `NX_OPT_DATABASE`	`choice: sqlite \| postgres`	`sqlite`
اتصال PostgreSQL `NX_OPT_DATABASE_DSN`	`secret`	`—`	الزامی · فقط وقتی database = postgres
نام کاربری ادمین `NX_OPT_ADMIN_USERNAME`	`string`	`admin`
رمز ادمین `NX_OPT_ADMIN_PASSWORD`	`password`	`—`	الزامی
آدرس عمومی نوتیف آدرسی که نوتیف را با آن باز می‌کنید، فقط پروتکل، میزبان و پورت. با HTTPS روشن همین حالا لازم است و پورت نوتیف را دارد (بدون پورت یعنی ۴۴۳). `NX_OPT_PUBLIC_URL`	`url`	`—`
گواهی HTTPS panel: گواهی پنل، روی هر پورت. acme: گواهی رایگان، پورت ۴۴۳. acme-http: همان روی هر پورت، بررسی روی ۸۰. self-signed: گواهی خودش، پنل برای اعتماد نشانش می‌دهد. off: HTTP ساده، پشت پراکسی. `NX_OPT_HTTPS`	`choice: panel \| acme \| acme-http \| self-signed \| off`	`panel`
پراکسی‌های مجاز ربات پراکسی‌های ربات، هر کجا: host:port با ویرگول. این سرور 127.0.0.1:10808؛ در داکر host.docker.internal:10808 (127.0.0.1 خود کانتینر است)؛ یا نشانی شبکهٔ محلی. `NX_OPT_LOCAL_PROXIES`	`string`	`—`

آنچه از پنل شما می‌خواهد

دسترسی	دلیل
`users:read`	to read the accounts it tells about: their contact details, expiry and traffic
`users:write`	to keep in an account's contact card the Telegram, Bale, Soroush Plus and Rubika chats its user links and the ntfy topic the admin turns on, and take them away when the user stops a bot

رویدادهایی که می‌شنود

panel.addon_removedpanel.restore_applieduser.createduser.activateduser.first_fetchuser.reneweduser.enableduser.disableduser.expireduser.quota_reacheduser.device_limit_reacheduser.deleteduser.bulkuser.generated