blob: 9f9e488aa671aca7f169161ed29abf879f5672c0 (
plain) (
blame)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
━━━━━━━━━
LEO
Andinus
━━━━━━━━━
Table of Contents
─────────────────
1. Installation
2. Documentation
.. 1. Profile
.. 2. Options
..... 1. encrypt/sign
..... 2. signify
..... 3. gzip
..... 4. help
3. Example
4. Demo
5. History
Leo is a simple backup program. It creates tar(1) files from a
pre-defined list. It can encrypt/sign files with gpg2(1) & sign files
with signify(1).
• Web-site: <https://andinus.nand.sh/leo>
• Source: <https://git.tilde.institute/andinus/leo>
• Source (mirror): <https://github.com/andinus/leo>
1 Installation
══════════════
┌────
│ # Install all the dependencies. (OpenBSD)
│ doas pkg_add p5-IPC-Run3 p5-Config-Tiny p5-Path-Tiny
│
│ # Clone the project.
│ git clone https://git.tilde.institute/andinus/leo && \
│ cd leo
│
│ # Install dependencies with cpanm.
│ cpanm --installdeps .
│
│ # Copy the config.
│ cp share/leo.conf $HOME/.config/leo.conf
│
│ # Copy the script & make it executable.
│ cp leo.pl $HOME/bin/leo && \
│ chmod +x $HOME/bin/leo
└────
2 Documentation
═══════════════
I use this to quickly backup some of my files. It works on profiles,
profiles are simple lists of files which get backed up.
2.1 Profile
───────────
Profile is a simple hash table (`%profile') which contains the list of
profiles. The profiles are mapped to a list of file paths which are to
be backed up.
You can run `help' to see all the profiles along with the paths.
2.2 Options
───────────
Some options can also be passed through environment variables. That
allows for configuration in shell rc file & the user can run leo
directly without looking at options.
━━━━━━━━━━━━━━━━━━━━━━━━
encrypt `LEO_ENCRYPT'
sign `LEO_SIGN'
signify `LEO_SIGNIFY'
gzip `LEO_GZIP'
━━━━━━━━━━━━━━━━━━━━━━━━
2.2.1 encrypt/sign
╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌
`encrypt_sign' handles `gpg2' related functions. It passes `--yes' by
default.
• `encrypt' / `sign' can also be set in configuration file, one can
also configure it for specific profile.
*Note*: `gpg2' might compress the backups depending on your config.
Default is to enable compression, if you don't want this then add `-z
0' to `@options'. `-z' specifies the compression level & 0 means no
compression.
2.2.2 signify
╌╌╌╌╌╌╌╌╌╌╌╌╌
`signify' will invoke `signify(1)' & the file will be signed.
2.2.3 gzip
╌╌╌╌╌╌╌╌╌╌
`gzip' will compress the tar archive with `gzip(1)'.
2.2.4 help
╌╌╌╌╌╌╌╌╌╌
Running just `leo' will print help.
3 Example
═════════
┌────
│ # This will encrypt, sign the tar file for documents, journal, pass &
│ # ssh profile.
│ leo --encrypt --sign documents journal pass ssh
│
│ # This will do the same. You can add these environment variables to
│ # your shell rc & then just run ``leo documents journal ssh pass'' to
│ # do the same.
│ LEO_ENCRYPT=1 LEO_SIGN=1 leo documents journal ssh pass
│
│ # Sign the file with signify(1).
│ leo --signify journal
└────
4 Demo
══════
It's very easy to setup `leo', I made a demo video to show this. I
already have Perl environment setup for this.
*Note*: Leo has changed since this was published.
• Leo 2020-08-31: <https://asciinema.org/a/F97hVfgXDcd9g5IlST1t27ps3>
You can also download the [cast file] directly & play it with
`asciinema'.
[cast file]
<https://andinus.nand.sh/static/leo/2020-08-31_leo-demo.cast>
5 History
═════════
This was Leo's initial description:
Leo is a program to run my personal scripts. You might not
find them useful, these were previously shell scripts that
I rewrote in Perl.
I had created a sync function initially & was going to expand it. Then
I decided to remove those sync functions because it was too complex, I
replaced then with simple `sh' scripts.
I added a simple `archive' function later & decided to turn Leo into
that function. So, it's not a meta-program anymore. I was thinking of
creating something that does all the things for me but that'll be too
complex.
Later on the same day I removed dispatch table & switched to using
simple hash of lists to store backup paths mapped to profiles. And
also changed the word "archive" to "backup" everywhere.
I added a simple INI based config file before 0.1.0 release.
|