summaryrefslogtreecommitdiff
path: root/doc/walkthrough/using_ssh_remotes.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/walkthrough/using_ssh_remotes.mdwn')
-rw-r--r--doc/walkthrough/using_ssh_remotes.mdwn33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/walkthrough/using_ssh_remotes.mdwn b/doc/walkthrough/using_ssh_remotes.mdwn
new file mode 100644
index 000000000..831746ac0
--- /dev/null
+++ b/doc/walkthrough/using_ssh_remotes.mdwn
@@ -0,0 +1,33 @@
+So far in this walkthrough, git-annex has been used with a remote
+repository on a USB drive. But it can also be used with a git remote
+that is truely remote, a host accessed by ssh.
+
+Say you have a desktop on the same network as your laptop and want
+to clone the laptop's annex to it:
+
+ # git clone ssh://mylaptop/home/me/annex ~/annex
+ # cd ~/annex
+ # git annex init "my desktop"
+
+Now you can get files and they will be transferred (using `rsync`):
+
+ # git annex get my_cool_big_file
+ get my_cool_big_file (getting UUID for origin...) (copying from origin...)
+ WORM:1285650548:2159:my_cool_big_file 100% 2159 2.1KB/s 00:00
+ ok
+
+When you drop files, git-annex will ssh over to the remote and make
+sure the file's content is still there before removing it locally:
+
+ # git annex drop my_cool_big_file
+ drop my_cool_big_file (checking origin..) ok
+
+Note that normally git-annex prefers to use non-ssh remotes, like
+a USB drive, before ssh remotes. They are assumed to be faster/cheaper to
+access, if available. There is a annex-cost setting you can configure in
+`.git/config` to adjust which repositories it prefers. See
+[[the_man_page|git-annex]] for details.
+
+Also, note that you need full shell access for this to work --
+git-annex needs to be able to ssh in and run commands. Or at least,
+your shell needs to be able to run the [[git-annex-shell]] command.