11<img src =" icon.svg " width =" 64 " alt /> Myba — git-based backup utility with encryption
22=====
33
4- [ ![ Build Status] ( https://img.shields.io/github/actions/workflow/status/kernc/myba/ci.yml?branch=master&style=for-the-badge )] ( https://github.com/kernc/myba/actions )
5- [ ![ Source lines of code] ( https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/kernc/myba/badge?filter=myba.sh$&style=for-the-badge&logo=github&color=skyblue&label=SLOC )] ( https://github.com/kernc/myba )
6- [ ![ Script size] ( https://img.shields.io/github/size/kernc/myba/myba.sh?style=for-the-badge&logo=github&color=skyblue )] ( https://github.com/kernc/myba )
4+ [ ![ Build status] ( https://img.shields.io/github/actions/workflow/status/kernc/myba/ci.yml?branch=master&style=for-the-badge )] ( https://github.com/kernc/myba/actions )
5+ [ ![ Language: shell / Bash] ( https://img.shields.io/badge/lang-Shell-skyblue?style=for-the-badge )] ( https://github.com/kernc/myba )
6+ [ ![ Source lines of code] ( https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/kernc/myba/badge?filter=myba.sh$&style=for-the-badge&color=skyblue&label=SLOC )] ( https://github.com/kernc/myba )
7+ [ ![ Script size] ( https://img.shields.io/github/size/kernc/myba/myba.sh?style=for-the-badge&color=skyblue )] ( https://github.com/kernc/myba )
78[ ![ Issues] ( https://img.shields.io/github/issues/kernc/myba?style=for-the-badge )] ( # )
8- [ ![ GitHub Sponsors] ( https://img.shields.io/github/sponsors/kernc?color=pink&style=for-the-badge )] ( https://github.com/sponsors/kernc )
9+ [ ![ Sponsors] ( https://img.shields.io/github/sponsors/kernc?color=pink&style=for-the-badge )] ( https://github.com/sponsors/kernc )
910
1011[ TOC]
1112
12- ** Myba ** (pronounced: mỹba ) ** is an
13+ ** _ Myba _ ** (pronounced: [ _ mỹba _ ] ( https://www.google.com/search?q=myba ) ) ** is an
1314open-source, secure, distributed, version-controlled, encrypted
1415file backup software based on ` git ` ** ,
1516for ** Linux, MacOS, BSDs** , and possibly even ** Windows/WSL** .
@@ -78,7 +79,7 @@ that **large binaries don't change too often**.
7879fully ** encrypted backups** that are really ** easily replicated and synced to the cloud** .
7980
8081<script src =" https://ssl.gstatic.com/trends_nrtr/3826_RC01/embed_loader.js " ></script >
81- <script >var now = ( new Date ()). toISOString (). split ( ' T ' )[ 0 ]; window .trends .embed .renderExploreWidget (" TIMESERIES" " comparisonItem" : [{" keyword" : " /m/02mhh1" " geo" : " " " time" : " 2004-01-01 " + now },{" keyword" : " /m/05vqwg" " geo" : " " " time" : " 2004-01-01 " + now },{" keyword" : " /m/0ryppmg" " geo" : " " " time" : " 2004-01-01 " + now} ]," category" : 0 ," property" : " " " exploreQuery" : " q=%2Fm%2F02mhh1,%2Fm%2F05vqwg,%2Fm%2F0ryppmg&date=all #TIMESERIES" " guestPath" : " https://trends.google.com:443/trends/embed/" script >
82+ <script >addEventListener ( " load " , () => window .trends .embed .renderExploreWidget (" TIMESERIES" " comparisonItem" : [{" keyword" : " /m/02mhh1" " geo" : " " " time" : " all " " keyword" : " /m/05vqwg" " geo" : " " " time" : " all " " keyword" : " /m/0ryppmg" " geo" : " " " time" : " all " },{ " keyword " : " myba " , " geo " : " " , " time " : " all " } ]," category" : 0 ," property" : " " " exploreQuery" : " date=all& q=%2Fm%2F02mhh1,%2Fm%2F05vqwg,%2Fm%2F0ryppmg,myba #TIMESERIES" " guestPath" : " https://trends.google.com:443/trends/embed/" ); </script >
8283
8384
8485### Use-cases
@@ -99,7 +100,7 @@ To install everything on a Debian/Ubuntu-based system, run:
99100# Install dependencies
100101sudo apt install gzip git git-lfs openssl gpg
101102
102- # Download and make available somewhere in path
103+ # Download and put somewhere on PATH
103104curl -vL ' https://bit.ly/myba-backup' > ~ /.local/bin/myba
104105export PATH=" $HOME /.local/bin:$PATH "
105106
@@ -110,14 +111,14 @@ Note, only one of `openssl` _or_ `gpg` is needed, not both!
110111It should be similar, if not nearly equivalent, to install on other platforms.
111112Hopefully you will find most dependencies already satisfied.
112113
113- Please report back if you find / manage to get this working under anything but the above configuration and especially Windows/WSL!
114+ Please report back if you find / manage to get this working under everything but the above configuration and especially Windows/WSL!
114115
115116
116117Usage
117118-----
118119You run the script with arguments according to the usage printout below.
119120Myba heavily relies on ` git ` and thus ** its command-line usage largely follows that of git convention** .
120- Most subcommands pass obtained arguments and options (` "@" ` ) straight to matching ` git ` subcommands!
121+ Most subcommands pass obtained arguments and options (` "$ @" ` ) straight to matching ` git ` subcommands!
121122``` text
122123Usage: myba <subcommand> [options]
123124Subcommands:
@@ -173,7 +174,7 @@ myba add Documents Photos Etc .dotfile
173174PASSWORD=' secret' " my precious"
174175myba remote add origin " /media/usb/backup"
175176myba remote add github " git@github.com:user/my-backup.git"
176- myba push # Push to all configured remotes & free disk space
177+ VERBOSE=1 myba push # Push to all configured remotes & free up disk space
177178
178179# Somewhere else, much, much later, avoiding catastrophe ...
179180
@@ -186,21 +187,23 @@ See [_smoke-test.sh_](https://github.com/kernc/myba/blob/master/smoke-test.sh) f
186187
187188Contributing
188189------------
189- The project is [ hosted on github ] ( https://github.com/kernc/myba/ ) .
190+ The project is [ hosted on GitHub ] ( https://github.com/kernc/myba/ ) .
190191
191192The script is considered _ mostly_ feature-complete, but there remain
192193bugs and design flaws to be discovered and ironed out, as well as any
193194[ TODOs and FIXMEs] ( https://github.com/search?q=repo%3Akernc%2Fmyba+%28todo+OR+fixme+OR+xxx%29&type=code )
194195marked in the source.
195196** All source code lines are open to discussion.**
196- Especially appreciated are clear pointers to targets for simplification.
197+ Especially appreciated are targets for simplification.
197198
198199
199200FAQ
200201---
202+ <div property =" about " typeof =" FAQPage " >
201203
202- <details markdown =" 1 " >
203- <summary >Is git a good tool for backups?</summary >
204+ <details markdown =" 1 " property =" mainEntity " typeof =" Question " >
205+ <summary property =" name " >Is git a good tool for backups?</summary >
206+ <div property =" acceptedAnswer " typeof =" Answer " ><div property =" text " >
204207
205208Git/myba's inherently core features allow you to:
206209
@@ -217,11 +220,12 @@ Git/myba's inherently core features allow you to:
217220of people and organizations worldwide,
218221with long and rigorous release / support cycles.
219222
220- </details >
221- <details markdown =" 1 " >
222- <summary >Git doesn't track file owner and access control / permissions ...</summary >
223+ </div ></div ></details >
224+ <details markdown =" 1 " property =" mainEntity " typeof =" Question " >
225+ <summary property =" name " >Git doesn't track file owner and access control / permissions ...?</summary >
226+ <div property =" acceptedAnswer " typeof =" Answer " ><div property =" text " >
223227
224- True . Files commited by any user are restorable by any user with the right password.
228+ Correct . Files commited by any user are restorable by any user with the right password.
225229In order to restore files with specific file permission bits set, ** defer to
226230[ umask] ( https://pubs.opengroup.org/onlinepubs/9799919799/utilities/umask.html ) ** ,
227231e.g.:
@@ -236,23 +240,27 @@ simply **write a small shell wrapper** that takes care of it.
236240** Welcome to contrib** anything short to the respect
237241you find widely-applicable and useful.
238242
239- </details >
240- <details markdown =" 1 " >
241- <summary >Git isn't optimized for continuously-changing databases and binary files ...</summary >
243+ </div ></div ></details >
244+ <details markdown =" 1 " property =" mainEntity " typeof =" Question " >
245+ <summary property =" name " >Is git optimized for continuously-changing databases and binary files?</summary >
246+ <div property =" acceptedAnswer " typeof =" Answer " ><div property =" text " >
242247
243- That is correct . Git saves whole file snapshots and doesn't do any in-file or within-file
248+ It's not . Git saves whole file snapshots and doesn't do any in-file or within-file
244249or across-file deduplication, so it's not well suited to automatic continuous backing up
245250of databases that change often.
246251
247252However, while git repositories bloat when commiting large binary and media files,
248253** _ myba_ only ever uses sparse-checkout** , keeping overhead disk space use to a minimum.
249254
250- </details >
251- <details markdown =" 1 " >
252- <summary >How to influence what files / filetypes to ignore from backup?</summary >
255+ </div ></div ></details >
256+ <details markdown =" 1 " property =" mainEntity " typeof =" Question " >
257+ <summary property =" name " >How to configure what files / filetypes to ignore from backup?</summary >
258+ <div property =" acceptedAnswer " typeof =" Answer " ><div property =" text " >
253259
254- You can edit ` $PLAIN_REPO/info/exclude ` , which is prepopulated with default common ignore patterns.
260+ You can edit ` $PLAIN_REPO/info/exclude ` , which is prepopulated with
261+ [ default common ignore patterns] ( https://github.com/search?q=repo%3Akernc%2Fmyba+%22default_gitignore%3D%22&type=code ) .
255262You can tweak various other git settings (like config, filters, hooks)
256- by modifying files in ` $PLAIN_REPO ` and ` $PLAIN_REPO/_encrypted/.git ` .
263+ by modifying respective files in ` $PLAIN_REPO ` and (encrypted repo) ` $PLAIN_REPO/_encrypted/.git ` .
257264
258- </details >
265+ </div ></div ></details >
266+ </div >
0 commit comments