edge-netdog

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 24, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

README

edge-netdog

edge-netdog performs emergency remediation (such as a reboot) for edge devices when network connectivity has failed.

It's useful on edge devices, like Raspberry Pi's, that need a last resort when unstable networks or unfriendly WiFi connections are a problem.

WARNING: This tool is intended for edge devices, and is not appropriate for typical servers.

Read more about the motivation here.

Usage

Download the latest version here.

Required/Minimal Configuration File
  • The target_url and target_match fields are required in the global section.
---
global:
    target_url: https://example.com
    target_match: Example Domain

actions:
    - echo network down
Full Configuration File

The remediation actions shown here may be appropriate for a Raspberry Pi on WiFi:

---
global:
    debug: true
    monitor_interval: 30s
    target_attempts: 4
    action_delay: 30s
    target_url: https://example.com
    target_match: Example Domain

actions:
    - sudo wpa_cli -i wlan0 reconfigure
    - sudo dhclient -v
    - sudo service networking restart
    - sudo reboot
  • You can test failures by changing the target_match to a random value.
  • For production, use a domain you control rather than example.com.

Contributing

Something bugging you? Please open an Issue or Pull Request - we're here to help!

New Feature Ideas? Please open a Pull Request.

All Humans Are Equal In This Project And Will Be Treated With Respect.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL