BisonBackup is a lightweight and modular backup script framework. It acts as a script runner that executes specified subscripts (called Modules) based on a user-defined configuration file (referred to as a Backup Plan).
This is just a personal project I worked on for my own needs. It’s definitely not a professional product, nor is it meant to be treated like one. I’m only sharing it in case someone else might find it useful, but please don’t expect anything close to finished, polished, or well-developed software. Make sure to read the License and Disclaimer section below in this README before even thinking about using this script or its modules.
- Modular Design: Integrate existing or your own script Modules and run them with customized parameters.
- Backup Plans: Centralized
.iniconfiguration files to manage Tasks and their execution parameters. - Dynamic Task Execution: Automatically runs Tasks with specified Modules and paths.
- Full Portability: BisonBackup is entirely written in pure Bash, requiring no additional dependencies. It should run seamlessly on any system that supports the Bash shell or its syntax.
- Simplicity by Design: Transform any Bash script into a flexible Module that receives parameters in a standardized argument format, as defined by the Backup Plan.
- Clone the repository:
git clone https://github.com/SilverLPs/BisonBackup.git
cd BisonBackup- Make the script executable:
chmod +x bisonbackup.sh- Create your own Backup Plan (see the Backup Plan Structure sections for details). Ensure the specified Modules are stored in the directory specified by "ModulePath" in your Backup Plan.
Run BisonBackup with your Backup Plan:
bisonbackup.sh <path-to-backup-plan.ini>When executed, BisonBackup provides detailed runtime information, including:
- Hostname
- Operating System and Kernel
- Current Directory
- Execution Timestamp
- User Information
- Plan Details (name, location, and associated paths)
It is advisable to redirect all output to a text file and retain it for future reference and analysis.
A Backup Plan is a simple .ini file that defines the Tasks and Modules to be executed. It is structured into multiple sections:
The Plan Section specifies the overall configuration for the Backup Plan. This section must appear at the top of the configuration file and is identified by [Plan] in brackets. Each Backup Plan requires a unique Plan Section.
- Name: The name of the Backup Plan.
- Path: The working directory for Tasks. If omitted, defaults to the current directory.
- ModulePath: The directory where the Modules are located.
Each Task is defined in its own section, specifying the Module and parameters required for execution. Task sections begin with a unique custom name enclosed in brackets, which must not be reused elsewhere in the Backup Plan.
- TaskModule: The Module to be executed for the Task. This is a required parameter.
- TaskPath: (Optional) The directory where the Task should be executed. If specified, BisonBackup will temporarily switch to this directory during the Task's execution.
- ARGUMENTS: Parameters written in uppercase (e.g.,
ARGUMENTS) are custom arguments passed to the specified Module. For details on a Module’s parameters, refer to its documentation.
[Plan]
Name=Demo Plan
Path=/home/demouser/
ModulePath=/home/demouser/.local/bisonbackup/modules/
[Hello world]
TaskModule=bisonbackup.general.command
TaskPath=
COMMAND="echo hello world test 123"
[Run example script]
TaskModule=bisonbackup.general.script
TaskPath=/home/demouser/myscripts/
SCRIPT="mycommand.sh"
ARGUMENTS="--myparameter=examplevalue"Modules are external scripts that are organized into Packages and located in the directory specified by the ModulePath parameter in the Backup Plan. A Package name usually combines the source of the Package and the Package theme (e.g., bisonbackup.general). Modules are executed by BisonBackup based on the Task configuration defined in the Backup Plan.
/home/demouser/.local/bisonbackup/modules/bisonbackup.general
- command.sh
- script.sh
- filelist.sh
- remove.sh
In the Backup Plan, Modules are referenced using a hierarchical naming convention:
Example: bisonbackup.general.filelist
- bisonbackup: Indicates the source of the Package.
- general: Refers to the Package containing a group of related Modules.
- filelist: Specifies the Module itself, corresponding to the script
filelist.sh.
Each Module is executed using the parameters specified in its corresponding task section, passed as arguments in the format SOURCE=/home/demouser/filepath DESTINATION=/home/demouser/filepath2.
BisonBackup's functionality is entirely provided by its Modules. Several "official" Packages are available as part of the BisonBackup project:
- 🧰 bisonbackup.general: General-purpose Modules for simple operations, such as running commands or handling file operations.
- 🌏 bisonbackup.networktransfer: Modules for transferring files and directories over various network protocols.
- 👾 bisonbackup.gitutils: Modules for interacting with Git repositories.
- 🏦 bisonbackup.borg: Modules designed for handling backups using BorgBackup.
These Packages are currently incomplete and contain only the specific Modules I have needed so far. Additional Modules may be added in the future if the project evolves.
In addition to these official Packages, I have also developed some personal module packages that are not part of the official BisonBackup project:
- 📧 silverlps.email: Modules for handling email operations.
- 💬 silverlps.discord: Modules for interacting with the Discord platform.
- ⌨️ silverlps.github: Modules for interacting with the GitHub platform.
For more details on the available module packages, refer to their respective documentation.
BisonBackup outputs logs directly to the console, including:
- Start and end timestamps for Tasks
- Task names
- Task output
- Errors (e.g., missing Modules or paths)
Contributions and issues reports are generally welcome! Please feel free to submit issues or pull requests on the GitHub repository. However, please be aware that this project is primarily developed for my personal purposes. While I share it in case it might be useful to others, I may not always be able to respond promptly to contributions or issue reports.
BisonBackup 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.