diff options
author | Joey Hess <joey@kitenet.net> | 2013-12-26 18:18:13 -0400 |
---|---|---|
committer | Joey Hess <joey@kitenet.net> | 2013-12-26 18:18:13 -0400 |
commit | de37fe1a227a593c3e5884f0cd4aab39065c0704 (patch) | |
tree | 67b625877441240910e2cc37661bbba8b03924bf /doc | |
parent | 310c39a6ad6027d37f6f0da437960566f5fd499a (diff) |
update for external special remotes
Diffstat (limited to 'doc')
-rw-r--r-- | doc/special_remotes.mdwn | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/doc/special_remotes.mdwn b/doc/special_remotes.mdwn index 6878a1f88..1a87f1a19 100644 --- a/doc/special_remotes.mdwn +++ b/doc/special_remotes.mdwn @@ -18,14 +18,8 @@ They cannot be used by other git commands though. * [[xmpp]] * [[hook]] -The above special remotes can be used to tie git-annex -into many cloud services. - -There are many use cases for a special remote. You could use it as a backup. You could use it to archive files offline in a drive with encryption enabled so if the drive is stolen your data is not. You could git annex move --to specialremote large files when your local drive is getting full, and then git annex move the files back when free space is again available. You could have one repository copy files to a special remote, and then git annex get them on another repository, to transfer the files between computers that do not communicate directly. - -The git-annex assistant makes it easy to set up rsync remotes using this last scenario, which is referred to as a transfer repository, and arranges to drop files from the transfer repository once they have been transferred to all known clients. - -None of these use cases are particular to particular special remote types. Most special remotes can all be used in these and other ways. It largely doesn't matter for your use what underlying transport the special remote uses. +The above special remotes are built into git-annex, and can be used +to tie git-annex into many cloud services. Here are specific instructions for using git-annex with various services: @@ -45,6 +39,29 @@ for using git-annex with various services: * [[Usenet|forum/nntp__47__usenet special remote]] * [chef-vault](https://github.com/3ofcoins/knife-annex/) +Want to add support for something else? [[Write your own!|external]] + +## Ways to use special remotes + +There are many use cases for a special remote. You could use it as a +backup. You could use it to archive files offline in a drive with +encryption enabled so if the drive is stolen your data is not. You could +git annex move --to specialremote large files when your local drive is +getting full, and then git annex move the files back when free space is +again available. You could have one repository copy files to a special +remote, and then git annex get them on another repository, to transfer the +files between computers that do not communicate directly. + +The git-annex assistant makes it easy to set up rsync remotes using this +last scenario, which is referred to as a transfer repository, and arranges +to drop files from the transfer repository once they have been transferred +to all known clients. + +None of these use cases are particular to particular special remote types. +Most special remotes can all be used in these and other ways. It largely +doesn't matter for your use what underlying transport the special remote +uses. + ## Unused content on special remotes Over time, special remotes can accumulate file content that is no longer |