Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 4.69 KB

README_en.md

File metadata and controls

87 lines (55 loc) · 4.69 KB

Introduction

Lastest Release GitHub All Releases

中文文档 | English

A plugin for OpenWRT routers to send various information notifications to a mobile phone via WeChat or Telegram. Supported services:

Push application Method description
WeChat Server Chan https://sct.ftqq.com/
WeChat PushPlus http://www.pushplus.plus/
WeChat WxPusher https://wxpusher.zjiecode.com/docs
WeChat for Enterprise Application Push https://work.weixin.qq.com/api/doc/90000/90135/90248
Telegram bot https://t.me/BotFather

Limited resources are available. If you need services such as DingTalk push, Feishu push, Bark push, etc., please try another branch at https://github.com/zzsj0928/luci-app-pushbot, or use custom API settings.

Main Features

  • Push notifications for changes in router IP and IPv6.
  • Push notifications for device online/offline status.
  • Device online list and traffic usage.
  • CPU load and temperature monitoring, PVE host temperature monitoring.
  • Periodic push notifications for router status.
  • Web and SSH login prompts for the router, automatic blacklist and port knocking.
  • Unattended tasks.

Instructions

Regarding Installation:

The plugin requires dependencies on iputils-arping + curl + jq + bash. For routers with limited memory, please consider the installation carefully. Before installing, please run the opkg update command to install dependencies during the installation process.

Developed based on X86 OpenWrt v23.05.0, different systems and devices may encounter various issues. If you encounter errors in temperature information retrieval, display errors, or other issues, please adapt accordingly.

Regarding Hostnames:

For devices that do not declare hostnames, devices connected via optical modem dial-up, OpenWrt used as a bypass gateway, and other scenarios where hostname retrieval fails, you can set the hostname using the following methods:

  • Use device name remarks.
  • Configure to obtain the hostname from the optical modem in advanced settings.
  • Enable MAC device database.
  • Install samba*-server or samba*-client to enable the program to query hostnames via NetBIOS.

Regarding Device Online Status:

By default, ping/arping is used to actively detect device online status to counter Wi-Fi sleep mechanism. Active detection takes more time but provides more accurate device online status.

  • If devices frequently go into sleep mode, please adjust the timeout settings in advanced settings.
  • If you don't require highly precise device online information and only need other features, you can disable active detection in advanced settings.

Regarding Traffic Statistics:

Traffic statistics functionality depends on wrtbwmon. Please install or compile it yourself. Enabling this plugin will conflict with Routing/NAT, Flow Offloading, proxy internet access, and other plugins, resulting in the inability to obtain traffic statistics. Please choose accordingly.

About Hard Drive Information:

When the OpenWrt system or remote host (PVE) does not have lsblk installed, the hard drive capacity information may be inconsistent with the actual capacity.

When the OpenWrt system or remote host (PVE) does not have smartctl installed, information such as hard drive temperature, uptime, and health status will not be available.

Regarding Bug Submissions:

When submitting a bug, please provide the following information if possible:

  • Device information and plugin version number.
  • Prompt information after executing /usr/share/wechatpush/wechatpush.
  • Log information and file information in the /tmp/wechatpush/ directory after encountering an error.
  • Detailed execution information of bash -x /usr/share/wechatpush/wechatpush t1.

DownLoad

Supported OpenWrt Versions Download Link
openwrt-19.07.0 ... latest Lastest Release
openwrt-18.06 Release v2.06.2

Donate

If you feel that this project is helpful to you, please donate to us so that the project can continue to develop and be more perfect.

image