Permalink
Browse files

README file

  • Loading branch information...
1 parent 7e21852 commit b7b46e30d351b2f0c46ab33da40f026d6d81a6cb @ccesario committed Aug 14, 2012
Showing with 46 additions and 0 deletions.
  1. +46 −0 pfsensebkp/README
View
@@ -0,0 +1,46 @@
+README
+======
+
+ This is a simple program to backup pfsense config file.
+
+
+REQUIREMENT
+
+ PHP5-CLI with SimpleXML and Curl extensions.
+
+
+USAGE
+
+ - Create a XML config file with the hosts data as example below:
+
+ <?xml version="1.0" ?>
+ <backup>
+ <backupdir>/data/backupPfsense</backupdir>
+ <logdir>/data/backupPfsense/logs</logdir>
+ <host>
+ <enabled>true</enabled>
+ <hostname>host1</hostname>
+ <address>192.168.1.1</address>
+ <protocol>http</protocol>
+ <port>8080</port>
+ <username>admin</username>
+ <pass>password</pass>
+ </host>
+ <host>
+ <enabled>true</enabled>
+ <hostname>host2</hostname>
+ <address>192.168.2.1</address>
+ <protocol>https</protocol>
+ <port>443</port>
+ <username>admin</username>
+ <pass>passwords</pass>
+ </host>
+ </backup>
+
+ - Save the the XML config file.
+ - Run the main program and specify the XML config as below:
+
+ php pfsensebkp.php --config config.xml
+
+ - The log files are stored in the directories specified in the configuration file.
+ - Make sure you have permission to read and write in backupdir and logdir directories.

0 comments on commit b7b46e3

Please sign in to comment.