From ff52937d7c0585dbb625d1c675fc3367279ed180 Mon Sep 17 00:00:00 2001 From: "Brian J. Tarricone" Date: Mon, 12 Aug 2024 21:40:21 -0700 Subject: [PATCH] Add readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..49ef658 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# openwrt-wan-failover + +This is a simple script/service that constantly pings your primary +interface (WAN) and secondary interface (WWAN, though I suppose in +practice it doesn't have to be a wireless WAN link). + +Install it with the `install.sh` script on your OpenWRT device, and +either reboot, or start it immediately with `service wan-failover +start`. + +There is currently no UI to configure it; use `uci` or manually edit the +provided sample configuration file before installing. + +Before starting the service, you should set your primary interface's +metric to 10, and the backup to 20.