mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs for borg special remote

Browse source 
(which DNE yet)
This commit is contained in:
Joey Hess 2020-12-17 13:12:35 -04:00
parent e9af56fef1
commit ef8c36254a
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/special_remotes.mdwn
View file

@ -25,6 +25,7 @@ the git history is not stored in them.
* [[webdav]]
* [[git]]
* [[httpalso]]
* [[borg]]
* [[xmpp]]
The above special remotes are built into git-annex, and can be used

24
doc/special_remotes/borg.mdwn Normal file
View file

@ -0,0 +1,24 @@
This special remote type accesses files stored in a
[borg](https://www.borgbackup.org/) repository.
This allows retrieving annexed files from borg repositories, and since
git-annex knows which files are stored in a borg repository, it can be
configured to treat the repository as one copy of the file.
Unlike most special remotes, this is read-only; it cannot change what
is stored in a borg repository. You do that by using borg as usual,
and then `git-annex sync` will learn about the files that are stored
in the borg repository.
## configuration
These parameters can be passed to `git annex initremote` to configure the
remote:
* `repository` - The location of a borg repository, eg a path, or
`user@host:path` for ssh access.
Setup example:
# borg init --encryption=keyfile /path/to/repo
# git annex initremote borg type=borg repository=/path/to/repo