docs for borg special remote
(which DNE yet)
This commit is contained in:
parent
e9af56fef1
commit
ef8c36254a
2 changed files with 25 additions and 0 deletions
|
@ -25,6 +25,7 @@ the git history is not stored in them.
|
||||||
* [[webdav]]
|
* [[webdav]]
|
||||||
* [[git]]
|
* [[git]]
|
||||||
* [[httpalso]]
|
* [[httpalso]]
|
||||||
|
* [[borg]]
|
||||||
* [[xmpp]]
|
* [[xmpp]]
|
||||||
|
|
||||||
The above special remotes are built into git-annex, and can be used
|
The above special remotes are built into git-annex, and can be used
|
||||||
|
|
24
doc/special_remotes/borg.mdwn
Normal file
24
doc/special_remotes/borg.mdwn
Normal 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
|
Loading…
Add table
Add a link
Reference in a new issue