Docker/pfsense-backup
1
0
Fork 0
Code Issues Actions Packages Activity

Update README.md

Browse Source
This commit is contained in:
Daniel Dolezal
2020-08-12 01:38:36 +02:00
committed by GitHub
parent 9e2c66aed8
commit a07db750c6
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -5
View File
@@ -1,4 +1,4 @@
# zxjinn/pfsense-backup # daniel156161/pfsense-backup
## Short description ## Short description
Runs a lightweight Alpine container to back up PFSense. Runs a lightweight Alpine container to back up PFSense.
@@ -6,7 +6,7 @@ Runs a lightweight Alpine container to back up PFSense.
## Full details ## Full details
This image can be used to run a one-time backup of PFSense, or it can be configured to stay in the background and retrieve backups on a user-specified schedule. This image can be used to run a one-time backup of PFSense, or it can be configured to stay in the background and retrieve backups on a user-specified schedule.
This has been tested to work against PFSense 2.3.3 and 2.3.4 and nothing else. It might stop working if PFSense changes something about how backups are completed. By default the backup will contain all the RRD data, if that is not desired see Parameters below. This has been tested to work against PFSense 2.3.3 and up to 2.4.5-RELEASE-p1 . It might stop working if PFSense changes something about how backups are completed. By default the backup will contain all the RRD data, if that is not desired see Parameters below.
### Running ### Running
#### One-time container #### One-time container
@@ -14,7 +14,7 @@ This is a good method for testing to ensure all the parameters are correct. If t
Running this command will start the container, connect to the PFSense host specified with the credentials provided and retrieve a backup. The backup file will be placed in the directory the command was run from, the container will then quit. Running this command will start the container, connect to the PFSense host specified with the credentials provided and retrieve a backup. The backup file will be placed in the directory the command was run from, the container will then quit.
``` ```
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 zxjinn/pfsense-backup 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 daniel156161/pfsense-backup
``` ```
#### Continuous container #### Continuous container
It's recommended to test the parameters with the one-time version above before trying the continuous backup mode out. It's recommended to test the parameters with the one-time version above before trying the continuous backup mode out.
@@ -23,17 +23,19 @@ Running this command will start the container and send it to the background. Whi
This specific command will back up once per day at midnight UTC, as the container's time zone is set to UTC. This specific command will back up once per day at midnight UTC, as the container's time zone is set to UTC.
``` ```
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 * * *' zxjinn/pfsense-backup 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 * * *' daniel156161/pfsense-backup
``` ```
### Parameters ### Parameters
- `PFSENSE_USER` Required. The PFSense user to log in with. - `PFSENSE_USER` Required. The PFSense user to log in with.
- `PFSENSE_PASS` Required. The password for the PFSense user specified. - `PFSENSE_PASS` Required. The password for the PFSense user specified.
- `PFSENSE_USER` Required. The IP (or DNS name) of the PFSense server. - `PFSENSE_IP` Required. The IP (or DNS name) of the PFSense server.
- `BACKUPNAME` Required. Backupname for xml.
- `PFSENSE_SCHEME` Required. Should either be `http` or `https`. This parameter is not validated. - `PFSENSE_SCHEME` Required. Should either be `http` or `https`. This parameter is not validated.
- `PFSENSE_CRON_SCHEDULE` Optional. The cron schedule to use, should contain 5 items separated by spaces. This parameter is not validated. No default. - `PFSENSE_CRON_SCHEDULE` Optional. The cron schedule to use, should contain 5 items separated by spaces. This parameter is not validated. No default.
- `PFSENSE_BACK_UP_RRD_DATA`. Optional. Should be either 1 or 0. This parameters is not validated. Include RRD data in the backup? 1=yes, 0=no. Default=1. - `PFSENSE_BACK_UP_RRD_DATA`. Optional. Should be either 1 or 0. This parameters is not validated. Include RRD data in the backup? 1=yes, 0=no. Default=1.
- `PFSENSE_BACKUP_DESTINATION_DIR`. Optional. What is the destination directory to back up to. This directory must exist and be writable. Default=/data - `PFSENSE_BACKUP_DESTINATION_DIR`. Optional. What is the destination directory to back up to. This directory must exist and be writable. Default=/data
- `TZ`. Optional. Timezone settings
## Help! ## Help!
- Is the username correct? - Is the username correct?