From 7021cabc41375553cc54aaff131dbbb9ea1b3409 Mon Sep 17 00:00:00 2001 From: Axel Hahn <ax2002@gmx.net> Date: Fri, 7 Oct 2022 22:17:43 +0200 Subject: [PATCH] update docs --- docs/10_Features.md | 4 ++++ docs/{50_Hooks.md => 50_Hooks/_index.md} | 0 docs/99_Glossary.md | 30 ++++++++++++++++++++++-- 3 files changed, 32 insertions(+), 2 deletions(-) rename docs/{50_Hooks.md => 50_Hooks/_index.md} (100%) diff --git a/docs/10_Features.md b/docs/10_Features.md index 134bd0b..80e3139 100644 --- a/docs/10_Features.md +++ b/docs/10_Features.md @@ -131,6 +131,10 @@ graph LR ``` +# Hooks # + +You have several entry points to execute your custom scripts before, after and during th backup process. +See [Hooks](50_Hooks/_index.md) # Backup tools # diff --git a/docs/50_Hooks.md b/docs/50_Hooks/_index.md similarity index 100% rename from docs/50_Hooks.md rename to docs/50_Hooks/_index.md diff --git a/docs/99_Glossary.md b/docs/99_Glossary.md index b95f767..d380819 100644 --- a/docs/99_Glossary.md +++ b/docs/99_Glossary.md @@ -1,19 +1,45 @@ ## Explaination of some words +### B + * **backup** = save current data "somewhare".<br>Store your backup outside the local system to have a copy you can access if the system is damaged. -* **cronjob** = start a command in a defined cycle. ie. eve3ry hour, every day, once a week and so on +### C + +* **cronjob** = start a command in a defined cycle. ie. every hour, every day, once a week and so on + +### D * **database dump** = backup a database / scheme into a single file +* **Duplicity** = Commandline backup tool; set of scripts written in Python; <https://duplicity.gitlab.io/duplicity-web/> + +### F + * **full backup** = backup of all data of the local system. +### H + +* **hook** = entry points during the backup process where you can execute custom scripts. + +### I + * **incremental backup** = backup of data that have changed since the last backup. +### P + * **prune** = delete old backup sets and thin data in the backup repository. <br>As an example: You can make an hourly backup and define to keep all of them for a week, daily backups for 90 days and monthly backups starting from 1 to 36 monthes (=3 years). The prune actions removes data in the backup storage to thin out your backup data. - + +### R + +* **Restic** = Commandline backup tool; a single binary is compiled with Go; <https://restic.net/> + * **restore** = copy data back from a made backup to the local system. +### T + * **ttl** = time to live<br>Definition how long an information is valid before it needs to be updated again. +### V + * **verify** = check the integrity of backup data \ No newline at end of file -- GitLab