pfSense Remote Config Backup

[] (https://flattr.com/submit/auto?user_id=echoes&url=https://github.com/echoes-tech/pfsense-remote-config-backup&description=Shell%20scripts%20for%20pfSense%20remote%20config%20backup.&lang=en_GB&category=software "Shell scripts for pfSense remote config backup")

Table of Contents

1. Overview
2. Scripts Description - What the scripts do and why they are useful
3. Setup - The basics of getting started with these scripts
   • Setup requirements
   • Beginning with these scripts
4. Usage - Configuration options and additional functionality
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to these scripts
7. Contributors

Overview

Shell scripts for pfSense remote config backup.

Scripts Description

These scripts backup remotely pfSense configuration.

Setup

Setup requirements

• A Unix shell
• Wget

Beginning with these scripts

1. mkdir -p /var/backups/pfsense
2. Copy one of the following scripts in the folder /usr/local/bin with the name backup-pfsense.sh.
3. [optional] Edit script to change variables USER and PASSWORD

pfSense 2.2.6 and Later

Get the 2.2.6 version here.

pfSense 2.0.x through 2.2.5

Get the 2.0 version here.

Usage

Standalone backup

sh /usr/local/bin/backup-pfsense.sh pfsense.foo.bar

BackupPC

$Conf{XferMethod} = 'rsync';
$Conf{DumpPreUserCmd} = 'sh /usr/local/bin/backup-pfsense.sh $host pre';
$Conf{DumpPostUserCmd} = 'sh /usr/local/bin/backup-pfsense.sh $host post';
$Conf{RsyncShareName} = [
  '/var/backups/pfsense'
];
$Conf{RsyncClientCmd} = '$rsyncPath $argList+';
$Conf{RsyncClientRestoreCmd} = '$rsyncPath $argList+';
$Conf{BackupFilesOnly} = {
  '/var/backups/pfsense' => [
    'config-*.xml'
  ]
};

Limitations

Tested on Debian.

Development

Echoes Technologies scripts on GitHub are open projects, and community contributions are essential for keeping them great.

Fork these scripts on GitHub

Contributors

The list of contributors can be found at: https://github.com/echoes-tech/pfsense-remote-config-backup/graphs/contributors