2020-12-18 15:06:23 +00:00
|
|
|
This special remote type accesses annexed files stored in a
|
2020-12-17 17:12:35 +00:00
|
|
|
[borg](https://www.borgbackup.org/) repository.
|
|
|
|
|
|
2020-12-18 15:06:23 +00:00
|
|
|
Unlike most special remotes, git-annex cannot be used to store annexed
|
|
|
|
|
files in this special remote. You store files by using borg as usual, to
|
|
|
|
|
back up the git-annex repository. Then `git-annex sync` will learn about
|
|
|
|
|
the annexed files that are stored in the borg repository.
|
2020-12-17 17:12:35 +00:00
|
|
|
|
|
|
|
|
## configuration
|
|
|
|
|
|
|
|
|
|
These parameters can be passed to `git annex initremote` to configure the
|
|
|
|
|
remote:
|
|
|
|
|
|
2020-12-18 20:03:51 +00:00
|
|
|
* `borgrepo` - The location of a borg repository, eg a path, or
|
2020-12-17 17:12:35 +00:00
|
|
|
`user@host:path` for ssh access.
|
|
|
|
|
|
2020-12-23 17:02:13 +00:00
|
|
|
* `subdir` - The subdirectory within the borg repository where git-annex
|
|
|
|
|
should look for annex object files. The default is to look through the
|
|
|
|
|
whole borg repository.
|
|
|
|
|
|
|
|
|
|
This is useful to avoid learning about annex objects in the borg
|
|
|
|
|
repository that belong to unrelated git-annex repositories. It can also
|
|
|
|
|
make syncing faster.
|
|
|
|
|
|
2020-12-18 15:06:23 +00:00
|
|
|
## setup example
|
|
|
|
|
|
|
|
|
|
# borg init --encryption=keyfile /path/to/borgrepo
|
2020-12-22 20:28:13 +00:00
|
|
|
# git annex initremote borg type=borg borgrepo=/path/to/borgrepo
|
2020-12-18 15:06:23 +00:00
|
|
|
# borg create /path/to/borgrepo `pwd`::{now}
|
|
|
|
|
# git annex sync borg
|
