zxjinn/pfsense-backup

zxjinn/pfsense-backup

镜像概述

本镜像基于轻量级Alpine容器，用于实现PFSense的备份功能。支持一次性备份或按用户指定的cron计划自动定时备份，已测试兼容PFSense 2.3.3和2.3.4版本。若PFSense备份机制发生变化，可能导致功能失效。默认备份包含所有RRD数据，可通过参数调整。

核心功能

• 一次性备份：快速验证备份参数正确性，完成后容器自动退出
• 定时备份：后台持续运行，按自定义cron计划定期生成备份文件
• 灵活配置：可选择是否包含RRD数据、指定备份目录、设置cron调度规则

使用场景

• 测试场景：通过一次性模式验证PFSense连接参数（用户名、密码、IP等）是否正确
• 生产场景：通过持续模式实现每日/定期自动备份，确保PFSense配置安全

部署示例

一次性备份模式

适合测试参数是否正确。执行后容器会连接PFSense并生成备份文件到当前目录，然后退出：

docker run --rm --volume $(pwd):/data --env PFSENSE_USER=backupuser --env PFSENSE_IP=192.168.0.1 --env PFSENSE_PASS=changeme --env PFSENSE_SCHEME=https docker.xuanyuan.run/zxjinn/pfsense-backup

持续定时备份模式

建议先通过一次性模式验证参数。容器后台运行，按指定cron计划定期备份（示例为UTC时间每日0点）：

docker run --detach --volume $(pwd):/data --env PFSENSE_USER=backupuser --env PFSENSE_IP=192.168.0.1 --env PFSENSE_PASS=changeme --env PFSENSE_SCHEME=https --env PFSENSE_CRON_SCHEDULE='0 0 * * *' docker.xuanyuan.run/zxjinn/pfsense-backup

配置参数

• PFSENSE_USER：必填，用于登录PFSense的用户名
• PFSENSE_PASS：必填，对应用户名的密码
• PFSENSE_IP：必填，PFSense服务器的IP或域名
• PFSENSE_SCHEME：必填，协议类型，可选http或https（未做验证）
• PFSENSE_CRON_SCHEDULE：可选，cron调度规则（5个空格分隔的字段），无默认值
• PFSENSE_BACK_UP_RRD_DATA：可选，是否包含RRD数据，1=是，0=否，默认1（未做验证）
• PFSENSE_BACKUP_DESTINATION_DIR：可选，备份目标目录（需存在且可写），默认/data

常见问题

• 用户名/密码是否正确？是否正确引用特殊字符？
• 容器使用UTC时区，cron计划需注意与本地时间的偏移

致谢

感谢https://hub.docker.com/r/furiousgeorge/pfsense-backup/%E6%8F%90%E4%BE%9B%E7%9A%84%E6%80%9D%E8%B7%AF%E5%92%8C%E9%83%A8%E5%88%86%E4%BB%A3%E7%A0%81%EF%BC%8C%E4%BB%A5%E5%8F%8Ahttps://github.com/hannah98/pfsense-backup%E7%9A%84%E5%BC%80%E6%BA%90%E9%A1%B9%E7%9B%AE%E3%80%82