BisonBackup modules designed for handling backups using BorgBackup
This module package is a part of the BisonBackup project. For more information about the project and detailed usage instructions, please refer to the project site.
This package relies on the following software:
Before using the modules in this package, please ensure that the listed software and all its dependencies are installed and available on your system.
Below is a list of all modules currently included in this package, along with their respective parameters:
backup - Creates a backup of a directory, including all its contents, into a backup repository via SSH. Ensure that the SSH key for authentication is correctly configured on your system.
- SOURCE = The local path to the directory to be backed up.
- DESTINATION = The URL path to the remote repository where the backup will be stored. Example: "ssh://[email protected]:23/./backups/repositoryname"
- PASSPHRASE = The passphrase for the backup repository (optional).
- REMOTEPATH = Specifies the version of Borg to use on the target repository (optional). Example: "borg-1.1"
This software is licensed under the MIT License. See LICENSE for more details.
BisonBackup is a private project developed in my spare time. It is provided "as is" without any warranty of any kind, either expressed or implied. I cannot offer any guarantees regarding its functionality, security, or suitability for a specific purpose. Anyone using the software does so entirely at their own risk.
Users are encouraged to thoroughly review the scripts and modules before using them. The software, including BisonBackup itself and all associated modules, is intended for technically proficient users who understand the potential risks and can assess whether the software meets their requirements. If you are not confident in your technical ability to understand or review the code, I strongly advise against using this software.
- Carefully review the provided scripts and configurations before running them.
- Test the software in a safe environment before applying it to critical data or systems.
- Use the software only if you are comfortable with its functionality and limitations.
This project is not intended for non-technical users, and I explicitly discourage anyone without a strong technical understanding from using this software.