From a99b09ee7bf42ca688edc4260b0e064d270d228f Mon Sep 17 00:00:00 2001 From: jgaunt Date: Thu, 2 Dec 2021 14:58:57 -0500 Subject: [PATCH] Update 'README.md' --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c24c0ee..c61b280 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,10 @@ You can pass in the `-f|--force` option to force the script to run. # Backup Router -The opnsense-carp-dhcp-backup.php should be saved to `/usr/local/etc/rc.syshook.d/config/20-opnsense-carp-dhcp-master` and made executable. This will update the gateway IP after the config is updated. Please replace the varaibles with your own values. \ No newline at end of file +The opnsense-carp-dhcp-backup.php should be saved to `/usr/local/etc/rc.syshook.d/config/20-opnsense-carp-dhcp-master` and made executable. This will update the gateway IP after the config is updated. Please replace the varaibles with your own values. + +## Variables +$wanInterface: This should be the wan interface as default. It could also be another opt# interface name as well. +$gatewayName: should be the name of the manual gateway used for the static WAN IP. +$wanStaticIP: This should be the private IP address for the Static WAN Interface. +$wanStaticIPSubnet: This should be the subnet bits for the Static WAN Interafce, ex. 30 \ No newline at end of file