Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrjackyliang/pfsense-ipv6-prefix-updater
Automatically update your pfSense® configuration when your Internet Service Provider (ISP) changes your dynamic IPv6 prefix
https://github.com/mrjackyliang/pfsense-ipv6-prefix-updater
dynamic-ip ipv6 ipv6-prefix pfsense pfsense-firewall
Last synced: 19 days ago
JSON representation
Automatically update your pfSense® configuration when your Internet Service Provider (ISP) changes your dynamic IPv6 prefix
- Host: GitHub
- URL: https://github.com/mrjackyliang/pfsense-ipv6-prefix-updater
- Owner: mrjackyliang
- License: mit
- Created: 2023-11-07T01:52:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-06T11:38:39.000Z (4 months ago)
- Last Synced: 2024-10-31T11:13:20.507Z (2 months ago)
- Topics: dynamic-ip, ipv6, ipv6-prefix, pfsense, pfsense-firewall
- Language: PHP
- Homepage: https://github.com/mrjackyliang/pfsense-ipv6-prefix-updater
- Size: 44.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
pfSense® Dynamic IPv6 Prefix Updater
=====================================
[](https://github.com/mrjackyliang/pfsense-ipv6-prefix-updater/releases)
[](https://github.com/mrjackyliang/pfsense-ipv6-prefix-updater)
[](https://github.com/mrjackyliang/pfsense-ipv6-prefix-updater/blob/main/LICENSE)
[](https://github.com/sponsors/mrjackyliang)
[](https://liang.nyc/paypal)
This script is specifically crafted to run on pfSense® environments to help automatically update the configuration when your Internet Service Provider (ISP) changes your dynamic IPv6 prefix.
It assists in automatically updating global IPv6 addresses saved in firewall aliases, static IPs, and virtual addresses used in IPsec, OpenVPN, and WireGuard configurations.
To use this updater, here are three simple steps you need to follow:
1. Download the **Cron** package from **Package Manager**.
2. Choose an interface, and configure your system with the given global IPv6 address.
3. Download the updater by following the [setup instructions](#setup-instructions).
## Setup Instructions
To download this updater, first login to **pfSense®** > **Diagnostics** > **Command Prompt**. Copy the provided command and then click the **Execute** button.
```shell
cd /root && fetch -o pfsense-ipv6-prefix-updater-install.sh https://cdn.jsdelivr.net/gh/mrjackyliang/pfsense-ipv6-prefix-updater/install.sh && sh pfsense-ipv6-prefix-updater-install.sh
```
__Note:__ The script runs as `root` and will reside in the `/root` folder.
## Setup Cron Scheduling
After downloading the script, go to **Services** > **Cron** > **Add** tab. Fill in the properties shown below (after determining the cron schedule, interface name, and prefix length) then click the **Save** button.
- __Minute:__ `*`
- __Hour:__ `*`
- __Day of the Month:__ `*`
- __Month of the Year:__ `*`
- __Day of the Week:__ `*`
- __User:__ `root`
- __Command:__ `php /root/pfsense-ipv6-prefix-updater/update.php [INTERFACE NAME] [PREFIX LENGTH]`
__Note:__ DO NOT use `wan` for the `INTERFACE NAME` since that 100% a /128 address. The `PREFIX LENGTH` will be defined by your Internet Service Provider (ISP) and should be between 48 and 64.
__Note 2:__ To calculate the cron schedule expression, visit the [crontab guru](https://crontab.guru) website.
__Note 3:__ When monitoring multiple interfaces, ensure that you run them at distinct time intervals, as only one instance is permitted to run simultaneously.
## WireGuard Peer Configurations
Even though the script can streamline the process of updating configurations on your pfSense® system, manual updates to peer configuration files are required due to the design of WireGuard. This is necessary to maintain the proper functioning of IPv6.
If you wish to be notified everytime the prefix is changed, please set up notifications in **System** > **Advanced** > **Notifications**.
## Root User Requirement
Typically, it is recommended to avoid running scripts under the `root` user. However, because of the `root:wheel` ownership of the configuration file (`/conf/config.xml`), the script requires execution under this user.
Rest assured, before applying any changes to the configuration file, the script will generate a backup of the `config.xml` file and store it in the `/root/pfsense-ipv6-prefix-updater/backups` folder.
## Credits and Appreciation
If you find value in the ongoing development of this updater and wish to express your appreciation, you have the option to become my supporter on [GitHub Sponsors](https://github.com/sponsors/mrjackyliang)!