UNPKG

backup-rotation

Version:

This script allows you to create a local or remote backup rotation for your files.

torben.website/backup-rotation

thaibault/backup-rotation

94 lines (67 loc) • 3.21 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<!-- #!/usr/bin/env markdown -*- coding: utf-8 -*- region header Copyright Torben Sickert (info["~at~"]torben.website) 16.12.2012 License ------- This library written by Torben Sickert stand under a creative commons naming 3.0 unported license. See https://creativecommons.org/licenses/by/3.0/deed.de endregion --> Project status -------------- [![npm](https://img.shields.io/npm/v/backup-rotation?color=%23d55e5d&label=npm%20package%20version&logoColor=%23d55e5d&style=for-the-badge)](https://www.npmjs.com/package/backup-rotation) [![npm downloads](https://img.shields.io/npm/dy/backup-rotation.svg?style=for-the-badge)](https://www.npmjs.com/package/backup-rotation) [![build push package](https://img.shields.io/github/actions/workflow/status/thaibault/backup-rotation/build-package-and-push.yaml?label=build%20push%20package&style=for-the-badge)](https://github.com/thaibault/backup-rotation/actions/workflows/build-package-and-push.yaml) [![deploy web documentation](https://img.shields.io/github/actions/workflow/status/thaibault/backup-rotation/deploy-web-documentation.yaml?label=deploy%20web%20documentation&style=for-the-badge)](https://github.com/thaibault/backup-rotation/actions/workflows/deploy-web-documentation.yaml) [![documentation website](https://img.shields.io/website-up-down-green-red/https/torben.website/backup-rotation.svg?label=documentation-website&style=for-the-badge)](https://torben.website/backup-rotation) Use case -------- This module provides backup rotation logic for arbitrary files. Features -------- - Daily, weekly and monthly backups as cronjob - Local and remote backups supported - Compressed backups (tar and gz is used). - Backup file structure is completely adaptable. - Configure an email address to get notified if your backup source isn't available. - Works incrementally (can complete interrupted backups after reboot e.g., uses rsync) - Completely configurable how long you plan to preserve your backup files - Optionally use your own synchronisation, compression and/or cleanup tool Usage ----- Run this script daily to generate your configured backup file structure. ```sh ./backupRotation.sh ``` or after installation: ```sh backup-rotation ``` Installation with yay from the arch user repository ----------------------------------------------------- ```sh yay --sync backupRotation ``` Manual installation on any posix compatible operating system ------------------------------------------------------------ Copy the script file "backupRotation.sh" to "/usr/bin/backup-rotation" and the provided timer and service files ("backupRotation.service" and "backupRotation.timer") to "/etc/systemd/system/backup-rotation.service" and "/etc/systemd/system/backup-rotation.timer" and enable services: Enable service under systemd ---------------------------- ```sh systemctl enable backup-rotation.timer ``` to enable the backup logic. After running: ```sh systemctl start backup-rotation.timer ``` you can see the worker running in your system logs and observe generated backup files. Configuration ------------- Simply create a text file under "/etc/backupRotation" and insert bash code which sets all options you want to overwrite.