msb/bashup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Matthew Saunders Brown 2021-01-23 15:28:19 -08:00
parent 39370cb6bf
commit ab721feae4
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -6,19 +6,19 @@ A set of bash scripts for managing backups.
Bashup includes scripts for backing up & restoring Files/Directories, MySQL databases, and PowerDNS zones. Bashup includes scripts for backing up & restoring Files/Directories, MySQL databases, and PowerDNS zones.
The scripts assume a mountable backup disk (cloud based block storage, NFS mount, etc.) but works equally well with a local partition or a local backup directory. If the backup dir is configured in /etc/fstab as a mountable disk then it will automatically be mounted and then unmounted when the scripts run. The scripts assume a mountable backup disk (cloud based block storage, NFS mount, dedicated local partion, etc.) but work equally a local backup directory. If the backup dir is configured in /etc/fstab as a mountable disk then it will automatically be mounted and then unmounted when the scripts run.
For "files" backups a combination of rsync & hard links is used. This conserves space as for files that are unchanged simply reference the same indode instead of having duplicate files. For "files" backups a combination of rsync & hard links is used. This conserves space as files that are unchanged simply reference the same indode instead of having duplicate files.
It is intended that each of the desired "backup" scripts is run once a day via cron. They scripts can be re-run multiple times in one day without any negative repercussions. If an existing backup already exists it is simply skipped, it is not overwritten with a newer copy. It is intended that each of the desired "backup" scripts is run once a day via cron. The scripts can be re-run multiple times in one day without any negative repercussions. If an existing backup already exists it is simply skipped, it is not overwritten with a newer copy.
The "restore" scripts can be run interatively. If you do not specify options for the restore then you will be prompted with menus of options to help you select what to restore. If the appropriate options are specified on the command line then the restore will be completed wihtout prompts. The "restore" scripts can be run interatively. If you do not specify options for the restore then you will be prompted with menus of options to help you select what to restore. If the appropriate options are specified on the command line then the restore will be completed without prompts.
Built and tested on Ubuntu 20.04 these scripts should run fine on any recent Debian or Debian based distro without any modifications. It should be trivial to expand support for other distros too, please contact the author if there is interest in this. Built and tested on Ubuntu 20.04 these scripts should run fine on any current Debian or Debian based distro without any modifications. It should be trivial to expand support for other distros too, please contact the author if there is interest in this.
## Quickstart ## Quickstart
Create a backup directory or mount. For example, make a directory named /mnt/backups and create an NFS mount for that directory. Create a backup directory or mount. For example, make a directory named /mnt/backups, create an NFS mount for that directory, and configure it in /etc/fstab. Include the "noauto" option in fstab so that it is not automatically mounted, the scripts will take care of mounting the device as needed.
```bash ```bash
cd /usr/local/src/ cd /usr/local/src/
@ -34,6 +34,6 @@ crontab -e
The "nano /usr/local/etc/bashup.cnf" command is optional. Do this if you need to override any of the settings at the top of the bashup scripts. The "nano /usr/local/etc/bashup.cnf" command is optional. Do this if you need to override any of the settings at the top of the bashup scripts.
For the crontab add an entry for each of the "bashup-backup-*.sh" scripts that you'd like to run. For example, to back up files at 3:01 am every day add this crontab: For the crontab add an entry for each of the "backup" scripts that you'd like to run. For example, to back up files at 3:01 am every day add this crontab:
`1 3 * * * /usr/local/sbin/bashup-backup-files.sh` `1 3 * * * /usr/local/sbin/bashup-backup-files.sh`