diff --git a/docs/10_Features.md b/docs/10_Features.md index 819deaa8e726525cf40b7c88b702b360fc5d545a..9cdf2cb060b56c7466881551b1465ddba24b9a9a 100644 --- a/docs/10_Features.md +++ b/docs/10_Features.md @@ -1,3 +1,21 @@ + +* Automatic backup of databases: A set of database backup scripts detects exsiting locally running database services and puts a compressed dump file per database scheme to a local backup directory. +* local encryption of all data to backup. +* no agent, no sattelite, no central backup server. We deploy the software and a config set to a server and the backup will run itself + +# How does it work? # + +There is scheduler, that waits for a time to start. + +For backup it makes + +* the dump of all found local databases and then +* transfer all files with a backup tool: + * locally encrypted files will be transferred to a mounted dir, ssh, rsync, https, (the available backaneds depend on the used backup tool) ... to a backup target system + * on the backup target each system has its own subdirectory or repository to store its data + + + # Database backup # Before starting the backup of local files to a backup target there is a step to dump a local @@ -16,6 +34,14 @@ Limited support: * couchdb (using a config with naming convention) * ldap (without restore so far) +# File backup # + +It is a classic backup a set of directories. Includes and excludes can be defined (but I prefer to backup all files). + +The backup target for local database backups is included automatically. + +Additionally there is a flag for a local Samba: if enabled all found shares will treated as directory to backup. + # Backup tools # ## Restic ## @@ -25,6 +51,7 @@ Limited support: * deduplicates files * delete backups by rules to keep a count of hourly, daily, weekly, mothly, yearly backups * several backup targets (currently supported protocols: sftp:// https:// and file://) +* Single binary (written in Go) ## Duplicity ## @@ -33,6 +60,7 @@ Limited support: * set size of backup volumes * delete old backups by a given time limit * several backup targets (currently supported protocols: scp:// rsync:// and file://) +* Backup script (written in Python) with dependencies and possibly differend versions on different OS # Limit simoultanous backups # diff --git a/docs/30_Configuration/20_Filetransfer b/docs/30_Configuration/20_Filetransfer.md similarity index 100% rename from docs/30_Configuration/20_Filetransfer rename to docs/30_Configuration/20_Filetransfer.md diff --git a/docs/_index.md b/docs/_index.md index 7f28ce7b6bbe6481668f6c331607739eef005aa9..0ef40ef3171cb2964e40f44cba3b1f29e61ceb56 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -1,6 +1,6 @@ # IML BACKUP # -Backup scripts using restic or duplicity. +Backup scripts using restic (or duplicity). Runs on Linux: CentOS, Debian, Manjaro, Ubuntu. @@ -16,5 +16,6 @@ for backup, monitoring and other general services. * **No central backup server**: We don't want to configure a backup set on a "central backup server" for each new node. Each new node pushes its own backup data to a given backup target.<br><br> * We want to **push data from a private network** to target; a central backup server would not reach some clients without sattelite systems.<br><br> +* No agent needed.<br><br> * **Automatic backup of databases**: A set of database backup scripts detects exsiting locally running database services and puts a compressed dump file per database scheme to a local backup directory.<br><br> * We want to use a **local encryption** of all data to backup. diff --git a/docs/config.json b/docs/config.json index eb24364b8be47e90bbb8cdc8d6a28b4361c2b754..4df2ac72061a6450be2f50580e32d3ada130a1c7 100644 --- a/docs/config.json +++ b/docs/config.json @@ -1,7 +1,7 @@ { "title": "IML Backup", "author": "Axel Hahn", - "tagline": "Automatic decentral server backups.", + "tagline": "Automatic decentral linux backups.", "ignore": { "files": ["30_PHP-client/Plugins/Checks/_skeleton.md"], "folders": ["99_Not_Ready"] diff --git a/docs/images/iml-backup-clientactions-simple.drawio.png b/docs/images/iml-backup-clientactions-simple.drawio.png new file mode 100644 index 0000000000000000000000000000000000000000..4466bdeeb503d8ec4fb2e56796d84c08c8d675d1 Binary files /dev/null and b/docs/images/iml-backup-clientactions-simple.drawio.png differ