NX Notif

от NX · notif

Официальные

Сообщает пользователям об аккаунтах — срок, трафик, продление и ваши сообщения — через Telegram, Bale, SMS, email или HTTP 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 этот порт отдаёт только его: публичный адрес называет этот порт (443 для acme). `NX_OPT_PORT`	`port`	`8097`
Путь админки Админка Notif, её 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`	`—`	обязательно
Публичный адрес Notif Адрес, по которому вы открываете Notif: только схема, хост и порт. С HTTPS он нужен сразу и называет порт Notif (без порта — 443). `NX_OPT_PUBLIC_URL`	`url`	`—`
Сертификат HTTPS panel: сертификат панели, любой порт. acme: бесплатный, порт 443. acme-http: то же, любой порт, проверка на 80. self-signed: свой, панель покажет его. off: HTTP за вашим прокси. `NX_OPT_HTTPS`	`choice: panel \| acme \| acme-http \| self-signed \| off`	`panel`
Разрешённые прокси ботов Прокси ботов где угодно, host:port через запятую: 127.0.0.1:10808; в docker host.docker.internal:10808 (127.0.0.1 — сам контейнер); адрес LAN. `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