https://github.com/itlinuxmaker/securesnap
SecureSnap Backup is used for automated backup of files and directories on Linux desktop systems or Linux servers.
https://github.com/itlinuxmaker/securesnap
backup-tool full-backup incremental-backups linux-desktop linux-server mysqldump-backup
Last synced: about 2 months ago
JSON representation
SecureSnap Backup is used for automated backup of files and directories on Linux desktop systems or Linux servers.
- Host: GitHub
- URL: https://github.com/itlinuxmaker/securesnap
- Owner: itlinuxmaker
- License: gpl-3.0
- Created: 2024-10-03T08:24:01.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-01T16:29:56.000Z (7 months ago)
- Last Synced: 2025-02-08T08:14:41.643Z (4 months ago)
- Topics: backup-tool, full-backup, incremental-backups, linux-desktop, linux-server, mysqldump-backup
- Language: Python
- Homepage: https://www.it-linuxmaker.com
- Size: 22.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SecureSnap Backup
SecureSnap Backup is used for automated backup of files and directories on Linux desktop systems or Linux servers. It supports full and incremental backups, backs up the installation state of the system and MySQL databases (optional). Furthermore, all steps are entered into a log file.
The configuration is done via a **YAML file** in which backup destinations, MySQL information and compression settings are specified.
## Features
- Full and incremental backups based on a configurable interval.
+ Full backup with incremental backups.
+ Full backups only.
+ Incremental backups only.
- Backup of MySQL databases (optional).
- Compression of backups (gzip, bzip2, xz).
- Backup of installed packages on the server.
- Exclusion of files and directories.
- Specifies the number of backups.
- Delete old backups once the specified number of backups is reached.
- Logging backup results and errors to a log file.
- Simple structured configuration via a **YAML file**.
## Installation
### Requirements
- Python 3.x
- python3-yaml
- `mysqldump` (if MySQL databases are to be backed up)
- `tar` for archiving
- Compression tools (gzip, bzip2 oder xz)
- Optional: `pytest` for testing
### Install dependencies
To run the program, the following Python modules are installed with `apt install` to make them available system-wide for a cron job:
```bash
apt-get update
apt install python3 python3-yaml
```
## Usage
Clone the project onto your Linux system
```Bash
git clone https://github.com/itlinuxmaker/SecureSnap.git
```
Change to the project directory and follow these steps:
1. Navigate to the securesnap directory:
```Bash
cd SecureSnap/src/securesnap
```
2. Create the configuration directory:
```Bash
mkdir -p /etc/securesnap
```
3. Copy the configuration and script files to their locations:
```
cp backup_config.yaml /etc/securesnap/
cp securesnap.py /usr/local/bin/
```
4. Edit the YAML configuration file to fit your backup requirements with your preferred text editor (vi, emacs, nano, etc.):
```
vi /etc/securesnap/backup_config.yaml
```
5. Run the backup script:
```
python3 /usr/local/bin/securesnap.py
```
6. Set up a cron job to automate the backup process (optional):
```
sudo crontab -e
```
Add the following line to run the backup every Friday at 21:00 as example:
```
00 21 * * Fri /usr/local/bin/securesnap.sh
```
## License
The program is licensed under the GNU General Public License v3.0 or later in 2024.
## Disclaimer
IN NO EVENT WILL I BE LIABLE FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, THOSE RESULTING FROM LOST PROFITS, LOST DATA, LOST REVENUE OR BUSINESS INTERRUPTION) ARISING OUT OF THE USE, INABILITY TO USE, OR THE RESULTS OF USE OF, THIS PROGRAM. WITHOUT LIMITING THE FOREGOING, I SHALL NOT BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES THAT MAY RESULT FROM THE USE OF THIS SCRIPT OR ANY PORTION THEREOF WHETHER ARISING UNDER CONTRACT, NEGLIGENCE, TORT OR ANY OTHER LAW OR CAUSE OF ACTION. I WILL ALSO PROVIDE NO SUPPORT WHATSOEVER, OTHER THAN ACCEPTING FIXES AND UPDATING THE SCRIPT AS IS DEEMED NECESSARY.