Commits

Jason Harris  committed b76267c

- Update help pages.

  • Participants
  • Parent commits 875ecf4

Comments (0)

Files changed (5)

File MacHgHelp/MacHgHelp.helpindex

Binary file modified.

File MacHgHelp/pgs/AboutSecurityAndPasswords.html

+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>About Security And Passwords</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<meta name="hatver" content="v2 R6"/>
+<meta name="builddefid" content="4111"/>
+<meta name="topicid" content="27594"/>
+<meta name="Keywords" content="server repository, server, external repository, password, secutiry, encryption, https, ssh, reference"/>
+<!-- do not translate -->
+<meta name="Keywords" content="MacHg" />
+<!-- end do not translate -->
+<meta name="Description" content="How to add a reference to a repository on a server."/>
+<meta name="template" content="2031"/>
+<meta name="pagetype" content="Task"/>
+<meta name="project" content="MacHgHelp"/>
+<meta name="release" content=""/>
+<meta name="projectcomponent" content="SafariSnow"/>
+<link href="../sty/task.css" rel="stylesheet" type="text/css" media="all"/>
+<link href="../sty/print.css" rel="stylesheet" type="text/css" media="print"/>
+</head>
+
+<body id="apple-pd">
+<!--top navigation area-->
+
+<div id="navbox" class="gradient"> <a name="AboutSecurityAndPasswords"></a>
+
+   <div id="navleftbox"> <a class="navlink_left" href="help:anchor='access' bookID=MacHg Help">Home</a> </div>
+
+   <div id="navrightbox"> <a class="navlink_right" href="help:anchor='xall' bookID=MacHg Help">Index</a> </div>
+</div>
+<!--page head-->
+
+<div id="headerbox">
+
+   <div id="iconbox"> <img id="iconimg" src="../gfx/hgicon.png" alt="MacHg icon" height="32" width="32"/> </div>
+
+   <div id="pagetitle">
+      <h1>About Security And Passwords</h1>
+   </div>
+</div>
+
+<p>
+When communicating with a server normally a password is required for access to make changes to the repository stored on the server. You have several options available in MacHg.
+
+     <ol>
+         <li>
+            <p>Use the https protocol</p>
+           <ul id="taskauxlistbulletedplain">
+               <li>
+                  <p class="listparagraph"> Storing the server password in the SystemKeychain</p>
+               </li>
+               <li>
+                  <p class="listparagraph"> Including the server password directly in the "Server URL", ie having a Server URL of the form: https://user:password@someserver/path/to/repo</p>
+               </li>
+            </ul>
+         </li>
+         <li>
+            <p>Use the ssh protocol</p>
+           <ul id="taskauxlistbulletedplain">
+               <li>
+                  <p class="listparagraph">Via passwordless login to the server</p>
+               </li>
+               <li>
+                  <p class="listparagraph">Storing the server password in the SystemKeychain</p>
+               </li>
+               <li>
+                  <p class="listparagraph"> Including the server password directly in the "Server URL",ie having a Server URL of the form: ssh://user:password@someserver/path/to/repo</p>
+               </li>
+            </ul>
+         </li>
+      </ol>
+</p>
+
+
+<div class="important">
+
+   <p> <span class="important-prefix">Important:</span>Be aware that if you store the password for the server directly in the Server URL, then MacHg will store this password in <strong>cleartext</strong> in your MacHg document. However, all communication with the server is <strong>always</strong> done using encrypted communication (this is part of https and ssh protocols). Thus you only ever need to worry about password security if someone can obtain direct access to your MacHg document on your machine. If you are worried about this, you can simply store your document in an encrypted disk image. Or you can store your passwords in the system keychain.
+</p>
+</div>
+
+</p>
+
+<p>
+One issue with storing your password in the system keychain is that MacHg will contact the server automatically at various intervals to confirm that it is reachable, etc. Thus it may appear to you that MacHg is accessing the server when it shouldn't be, however these access requests are a normal part of the functioning of MacHg.
+</p>
+
+<div class="important">
+
+   <p> <span class="important-prefix">Note:</span>If you are having connection problems, it is sometimes easier to include the password in the Server URL since it is clearer what is going on when diagnosing problems. </p>
+</div>
+
+<p>
+(Note: for comparison, if you are communicating with a server through passwordless ssh, then your ssh keys are also stored in your ~/.ssh directory. Thus anyone with access to your machine will be able to copy your ~/.ssh/id_rsa private key and hence steal your nuclear codes, etc. (To get around this you would need to use ssh-agent.))
+</p>
+
+<p>
+Thus, really, the storage of passwords in cleartext in a MacHg document has about the same security as ssh passwordless login.
+</p>
+
+<div id="rule">
+   <hr />
+</div>
+
+<div id="linkinternalbox">
+   <h3>Related Topics</h3>
+
+   <p class="linkinternal"><a href="help:anchor=AddingServerRepository bookID=MacHg Help">Adding a Server Repository</a></p>
+
+</div>
+
+</body>
+</html>

File MacHgHelp/pgs/AddingServerRepository.html

 </div>
 
 <p> <a href="help:anchor=AboutRepositories_ServerRepositories bookID=MacHg Help">External repositories</a>, when "added" to your MacHg documents, are included just as references. Once
-   you have a server reference in your document, you will then be able to <a href="help:anchor=PushingChanges bookID=MacHg Help">push</a> (upload) changes from your computer to that server or <a href="help:anchor=PullingChanges bookID=MacHg Help">pull</a> (download) changes from that server to your computer. </p>
+   you have a server reference in your document, you will then be able to <a href="help:anchor=CloningARepository bookID=MacHg Help">clone</a> (copy) the repository on the server, <a href="help:anchor=PushingChanges bookID=MacHg Help">push</a> (upload) changes from your computer to that server or <a href="help:anchor=PullingChanges bookID=MacHg Help">pull</a> (download) changes from that server to your computer. </p>
 
 <div class="task-box-spacing">
 
          <li>
             <p>In the dialog that appears, enter a short name of your choosing to help you identify the external repository. This short name will be used in the left <a href="help:anchor=AboutRepositoryLists bookID=MacHg Help">sidebar</a> and in other places to refer to this external repository.</p>
          </li>
+         <li>
+            <p>Once you have entered a shortname and Server URL the connection will be automatically tested. You can however click the small button labeled 'test' to test the connection to the server in the terminal. This is sometimes useful to diagnose problems.</p>
+         </li>
       </ol>
    </div>
 </div>
+<div class="important">
+
+   <p> <span class="important-prefix">Important:</span> Removing a repository just removes the <strong>reference</strong> to the repository. It doesn't actually move the folder of files to the trash, or remove the repository from the server. However, when deleting a local repository, you are given the option of moving the actual repository (the folder of files on your machine) to the trash. Choose this option with care.</p>
+</div>
+<div class="important">
+
+   <p> <span class="important-prefix">Note:</span>If you store the password directly in the "Server URL" field, the password will be stored in cleartext in your MacHg document. The password will still <strong>always</strong> be sent in an encrypted form if you are using https or ssh since this is part of the protocol. You can, if desired, store your password in the system keychain by checking the option 'Use Password:'.</p>
+</div>
+
+<div id="rule">
+   <hr />
+</div>
+
+<div id="linkinternalbox">
+   <h3>Related Topics</h3>
+
+   <p class="linkinternal"><a href="help:anchor=AboutSecurityAndPasswords bookID=MacHg Help">About Security And Passwords</a></p>
+
+</div>
+
+
 </body>
 </html>

File MacHgHelp/pgs/Shortcuts.html

       <p class="listparagraph"> <a href="help:anchor=AboutTheDifferencesView bookID=MacHg Help">The Differences View</a></p>
    </li>
 </ul>
+
+<h2>Drag and Drop</h2>
+<p>You can use drag and drop in:</p>
+<ul id="taskauxlistbulletedplain">
+   <li>
+      <p class="listparagraph"><a href="help:anchor=AboutRepositoryLists bookID=MacHg Help">The Repository List (<a href="help:anchor=AboutRepositoryLists bookID=MacHg Help">sidebar</a>)</a> to drag repositories in from the OSX Finder.</p>
+   </li>
+      <li>
+      <p class="listparagraph"><a href="help:anchor=AboutRepositoryLists bookID=MacHg Help">The Repository List (<a href="help:anchor=AboutRepositoryLists bookID=MacHg Help">sidebar</a>)</a> to reorder repositories in the sidebar.</p>
+   </li>
+   <li>
+      <p class="listparagraph">The Import Patches Sheet. You can add patches by directly dragging the patch files in from the OSX Finder.</p>
+   </li>
+</ul>
+
 </body>
 </html>

File MacHgHelp/xpgs/xall.html

 <div class ="letterhead"><a name="R"></a>R</div>
 
 <div class="indexitem"><div class="indexentrytext"> 
-<a href="help:anchor=RemovingRepositoryItem bookID=MacHg Help">Removing Repository Itemes</a>
+<a href="help:anchor=RemovingRepositoryItem bookID=MacHg Help">Removing Repository Items</a>
 </div><div class="seealsotext"><span class="seealsoprefix"></div></div>
 
 
 <div class ="letterhead"><a name="S"></a>S</div>
 
 <div class="indexitem"><div class="indexentrytext"> 
+<a href="help:anchor=AboutSecurityAndPasswords bookID=MacHg Help">Security And Passwords</a>
+</div><div class="seealsotext"><span class="seealsoprefix"></div></div>
+
+<div class="indexitem"><div class="indexentrytext"> 
 <a href="help:anchor=Shortcuts bookID=MacHg Help">Shortcuts</a>
 </div><div class="seealsotext"><span class="seealsoprefix"></div></div>