almostm4/Backify
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
gospodar 2023-02-11 11:41:19 +01:00
parent 89086a68d3
commit f7b736b101
1 changed files with 41 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.MD
View File

@ -1,36 +1,32 @@
# Backify 🗃️ Backify 🗃️
===========
I don't know why are You here, but I wouldn't be in Your skin. A powerful and automated bash script for backing up all kinds of Linux data, archiving it and pushing it to a remote host.
What is Backify? 👾
-------------------
## What's this ? 👾 Backify is a shell script that helps you automate the backup process of all kinds of data from Linux systems. It differs from other backup scripts because it gives you the flexibility to choose what you want to save, ranging from system logs to containers. The script was tailored to meet personal needs as there was no complete solution for the specific use case.
Backify is a shell script that helps You automate backup of all kind of data from Linux systems.
What makes it different ? Most of backup scripts are specialised for one kind of data backup, while here You get to pick what do You want saved, reaching from system logs all the way to containers.
It was tailored to personal needs since there was no complete solution for the specific use case.
## How do I configure it ? 🧙‍♂️
All of the options are included in the backup.cfg file.
The script has an integrity check for the configuration, so no external command can be embedded into it by any kind of malware.
See the table below for configuration options
## Configuration options 🪄
Configuration 🧙‍♂️
-------------------
All configuration options can be found in the `backup.cfg` file. The script has an integrity check in place to ensure that no external commands can be embedded into it by malware. The following table provides an overview of the available configuration options:
| Name | Value | Specifics | | Name | Value | Specifics |
|----------------|-------------------------------|-----------------------------| | --- | --- | --- |
| Enabled | true/false | Disable the main function | | Enabled | true/false | Disable the main function |
|www_backup |true/false |Backup of webroot directory | | www_backup | true/false | Backup of the webroot directory |
|www_dir |------> |Path to webroot | | www_dir | ------> | Path to the webroot |
|vhost_backup |true/false |Backup of vhost configuration| | vhost_backup | true/false | Backup of the vhost configuration |
|vhost_dir |------> |Path to vhost files | | vhost_dir | ------> | Path to the vhost files |
| log_backup | true/false | Backup log files | | log_backup | true/false | Backup log files |
| log_backup_web | true/false | Backup web app logs | | log_backup_web | true/false | Backup web app logs |
| apache | true/false | Enable Apache logs | | apache | true/false | Enable Apache logs |
| nginx | true/false | Enable nginx logs | | nginx | true/false | Enable nginx logs |
| fail2ban_log | true/false | Enable fail2ban logs | | fail2ban_log | true/false | Enable fail2ban logs |
| log_purge | true/false | Truncate logs after backup | | log_purge | true/false | Truncate logs after backup |
|rsync_push |true/false |Push the backup file to remote server| | rsync_push | true/false | Push the backup file to a remote server |
| push_clean | true/false | Delete the backup file after push | | push_clean | true/false | Delete the backup file after push |
| target_host | ------> | Backup push target host | | target_host | ------> | Backup push target host |
| target_user | ------> | Backup push target username | | target_user | ------> | Backup push target username |
@ -40,11 +36,8 @@ See the table below for configuration options
| docker_volumes | true/false | Backup Docker volumes | | docker_volumes | true/false | Backup Docker volumes |
| docker_data | true/false | Backup container information | | docker_data | true/false | Backup container information |
To-Do List
----------
## ToooooooDoooooooo
- [ ] Rsync implementation via shell - [ ] Rsync implementation via shell
- [ ] Rsync implementation via Docker - [ ] Rsync implementation via Docker