add a pairing walkthrough

7 files changed, 54 insertions, 0 deletions

diff --git a/doc/assistant.mdwn b/doc/assistant.mdwn
index 76b208a1a..bccd029e0 100644
--- a/doc/assistant.mdwn
+++ b/doc/assistant.mdwn
@@ -28,6 +28,11 @@ interface to add repositories and control the git-annex assistant.
 
 [[!img assistant/running.png]]
 
+## documentation
+
+* Want to make two nearby computers share the same synchronised folder?
+  Follow the [[pairing_walkthrough]].
+
 ## command line start
 
 The git-annex assistant will automatically be started when you log in to
diff --git a/doc/assistant/pairing_walkthrough.mdwn b/doc/assistant/pairing_walkthrough.mdwn
new file mode 100644
index 000000000..112c19eb0
--- /dev/null
+++ b/doc/assistant/pairing_walkthrough.mdwn
@@ -0,0 +1,49 @@
+So you have two computers in the same building, and you want them to share
+the same synchronised folder, communicating directly with each other.
+
+This is incredibly easy to set up with the git annex assistant.
+
+Let's say the two computers are your computer and your friend's computer.
+We'll start on your computer, where you open up your git annex dashboard.
+
+[[!img addrepository.png alt="Add another repository button"]]
+
+`*click*`
+
+[[!img pairing.png alt="Pair with local computer"]]
+
+Now the hard bit. You have to think up a secret phrase, and type it in..
+
+[[!img secret.png alt="Enter secret phrase"]]
+
+Now your computer is in pairing mode. When your friend looks at her git
+annex dashboard, she sees something like this.
+
+[[!img pairrequest.png alt="Pair request"]]
+
+`*click*`
+
+[[!img secretempty.png alt="Enter same secret phrase"]]
+
+Now it's up to you to let her know what the secret is. As soon as she
+enters it, both your computers will be paired, and will begin to sync their
+git-annex folders. Just like that you can share files.
+
+----
+
+Something to keep in mind, especially if pairing doesn't seem to be
+working, is that the two computer need to be on the same network for this
+pairing process to work. Sometimes a building will have more than one
+network inside it, and you'll need to connect them both to the same one.
+Make sure the wireless network name is the same, or that they're both
+plugged into the same router.
+
+Also, the file sharing set up by this pairing only works when both
+computers are on the same network. If you go on a trip, any files you
+edit will not be visible to your friend until you get back. **But**,
+you can get around this by hooking both computers up to a server on the
+internet, which they can use to exchange files. The git annex assistant
+makes that easy too.
+
+And also, you can pair with as many other computers as you like, not just
+one!
diff --git a/doc/assistant/pairing_walkthrough/addrepository.png b/doc/assistant/pairing_walkthrough/addrepository.png
new file mode 100644
index 000000000..b82efdbea
--- /dev/null
+++ b/doc/assistant/pairing_walkthrough/addrepository.png
diff --git a/doc/assistant/pairing_walkthrough/pairing.png b/doc/assistant/pairing_walkthrough/pairing.png
new file mode 100644
index 000000000..dfbbf0641
--- /dev/null
+++ b/doc/assistant/pairing_walkthrough/pairing.png
diff --git a/doc/assistant/pairing_walkthrough/pairrequest.png b/doc/assistant/pairing_walkthrough/pairrequest.png
new file mode 100644
index 000000000..8d3f603bf
--- /dev/null
+++ b/doc/assistant/pairing_walkthrough/pairrequest.png
diff --git a/doc/assistant/pairing_walkthrough/secret.png b/doc/assistant/pairing_walkthrough/secret.png
new file mode 100644
index 000000000..1eb805122
--- /dev/null
+++ b/doc/assistant/pairing_walkthrough/secret.png
diff --git a/doc/assistant/pairing_walkthrough/secretempty.png b/doc/assistant/pairing_walkthrough/secretempty.png
new file mode 100644
index 000000000..491878784
--- /dev/null
+++ b/doc/assistant/pairing_walkthrough/secretempty.png