improve html, add screenshots
authorJoey Hess <joeyh@joeyh.name>
Tue, 27 Dec 2016 21:13:32 +0000 (17:13 -0400)
committerJoey Hess <joeyh@joeyh.name>
Tue, 27 Dec 2016 21:13:32 +0000 (17:13 -0400)
Assistant/WebApp/Configurators/Pairing.hs
doc/assistant/share_with_a_friend_walkthrough.mdwn
doc/assistant/share_with_a_friend_walkthrough/enabletor.png [new file with mode: 0644]
doc/assistant/share_with_a_friend_walkthrough/wormholepairing.png [new file with mode: 0644]
templates/configurators/pairing/wormhole/prompt.hamlet
templates/configurators/pairing/wormhole/start.hamlet

index fa9c53dae2e62ddc128bf6b8c35c6ba986df4574..21fd2a4ff6f16218d28e7e5534aa8e2c5f119d8d 100644 (file)
@@ -18,16 +18,17 @@ import Assistant.DaemonStatus
 import Assistant.Pairing.MakeRemote
 import Assistant.Pairing.Network
 import Assistant.Ssh
-import Assistant.Alert
 import Utility.Verifiable
 #endif
 import Utility.UserInfo
 import Utility.Tor
 import Assistant.WebApp.Pairing
+import Assistant.Alert
 import qualified Utility.MagicWormhole as Wormhole
 import Assistant.MakeRemote
 import Assistant.RemoteControl
 import Assistant.Sync
+import Assistant.WebApp.SideBar
 import Command.P2P (unusedPeerRemoteName, PairingResult(..))
 import P2P.Address
 import Git
@@ -57,7 +58,7 @@ startWormholePairR pairingwith = whenTorInstalled $ whenWormholeInstalled $
 
 getPrepareWormholePairR :: PairingWith -> Handler Html
 getPrepareWormholePairR pairingwith = do
-       enableTor
+       -- enableTor
        myaddrs <- liftAnnex loadP2PAddresses
        remotename <- liftAnnex unusedPeerRemoteName
        h <- liftAssistant $
index a478fb3272f9a70c86c8330393265500513a7dad..e820a6862ab989f032890407f9454a06aad224be 100644 (file)
@@ -16,11 +16,15 @@ Start by opening up your git annex dashboard.
 
 `*click*`
 
-Now you will probably be prompted to enter a password, to configure Tor.
+[[!img enabletor.png alt="Enabling tor hidden service"]]
+
+You will probably be prompted to enter a password, to configure Tor.
 (Depending on how your system is configured, this may be the root password,
 or your user account's password.)
 
-Then, a pairing code will be generated. Tell it to your friend. Ask them
+[[!img wormholepairing.png alt="Pairing with a friend form"]]
+
+A pairing code will be generated. Tell it to your friend. Ask them
 for their pairing code, and enter it in the form.
 
 Once you've exchanged pairing codes, your repositories will be connected
diff --git a/doc/assistant/share_with_a_friend_walkthrough/enabletor.png b/doc/assistant/share_with_a_friend_walkthrough/enabletor.png
new file mode 100644 (file)
index 0000000..6dd2856
Binary files /dev/null and b/doc/assistant/share_with_a_friend_walkthrough/enabletor.png differ
diff --git a/doc/assistant/share_with_a_friend_walkthrough/wormholepairing.png b/doc/assistant/share_with_a_friend_walkthrough/wormholepairing.png
new file mode 100644 (file)
index 0000000..a2817da
Binary files /dev/null and b/doc/assistant/share_with_a_friend_walkthrough/wormholepairing.png differ
index ece78c0d08d0739d668b276d1a096b400b165ef0..b3341b39ab897872ec57112555cf2bcfe621e379 100644 (file)
@@ -20,8 +20,7 @@
     <p>
       $case pairingwith
         $of PairingWithSelf
-          Enter that code into the webapp of the device you want to #
-          pair with.
+          Enter that code into the device you want to pair with. #
         $of PairingWithFriend
           Tell that code to your friend. #
     <p>
             <div .col-sm-10 .col-sm-offset-2>
               <button .btn .btn-primary type=submit>
                 Finish pairing
+  <div .content-box>
+    <h3 .alert-heading>
+      ^{htmlIcon InfoIcon} Keep pairing codes safe
+    $case pairingwith
+      $of PairingWithSelf
+        <p>
+          Pairing codes can only be used a single time, but if someone #
+          saw the pairing codes before you use them, they could #
+          pair with your devices. So be careful with the pairing codes!
+      $of PairingWithFriend
+        <p>
+          Pairing codes can only be used a single time, but if someone #
+          overhears you exchanging them with your friend, they could #
+          pair with your repositories. #
+        <p>
+          Here are some suggestions for how to exchange the pairing #
+          code with your friend, with the safest ways first:
+          <ul>
+            <li>
+              In person.
+            <li>
+              In an encrypted message #
+              (gpg signed email, Off The Record (OTR) conversation, etc).
+            <li>
+              By a voice phone call.
index b62873cb52fa750a63f2be652078f2ecba4fb4ad..605efe919efcb651029515c53423ecfa5ed8fcd1 100644 (file)
@@ -5,7 +5,7 @@
         $of PairingWithSelf
           Preparing for pairing your devices
         $of PairingWithFriend
-          reparing for pairing with a friend
+          Preparing for pairing with a friend
     <p>
       Pairing will connect two git-annex repositories using #
       <a href="https://torproject.org/">Tor</a>, #