forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kpiroum...@apache.org
Subject cvs commit: xml-forrest/src/documentation/content/xdocs/community/howto/cvs-ssh book.xml howto-cvs-ssh.xml
Date Mon, 27 May 2002 11:07:48 GMT
kpiroumian    02/05/27 04:07:47

  Modified:    src/documentation/content/xdocs/community/howto book.xml
                        index.xml
  Added:       src/documentation/content/xdocs/community/howto/cvs-ssh
                        book.xml howto-cvs-ssh.xml
  Log:
  HowTo configure CVS through SSH document.
  
  Revision  Changes    Path
  1.2       +5 -0      xml-forrest/src/documentation/content/xdocs/community/howto/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/community/howto/book.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- book.xml	25 May 2002 07:29:51 -0000	1.1
  +++ book.xml	27 May 2002 11:07:47 -0000	1.2
  @@ -12,4 +12,9 @@
       <menu-item label="With Images" href="bugzilla-patch/howto-bugzilla-patch.html"/>
     </menu>
   
  + <menu label="Committers">
  +    <menu-item label="CVS through SSH" href="cvs-ssh/howto-cvs-ssh.html"/>
  +  </menu>
  +
  +
   </book>
  
  
  
  1.2       +1 -0      xml-forrest/src/documentation/content/xdocs/community/howto/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/community/howto/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	25 May 2002 07:29:51 -0000	1.1
  +++ index.xml	27 May 2002 11:07:47 -0000	1.2
  @@ -36,6 +36,7 @@
   <li><link href="v10/howto-v10.html">Single Page How-To</link></li>
   <li><link href="xmlform/howto-xmlform.html">Multi-Page How-To with Revisions</link></li>
   <li><link href="bugzilla-patch/howto-bugzilla-patch.html">How-To with Images</link></li>
  +<li><link href="cvs-ssh/howto-cvs-ssh.html">CVS through SSH</link></li>
   	</ul>
   
   	</section>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/cvs-ssh/book.xml
  
  Index: book.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "book-cocoon-v10.dtd">
  
  <book software="Forrest"
        title="Forrest"
        copyright="2002 The Apache Foundation"
        xmlns:xlink="http://www.w3.org/1999/xlink">
        
  
    <menu label="How-Tos">
      <menu-item label="Index" href="../index.html"/>
    </menu>
  
  </book>
  
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/community/howto/cvs-ssh/howto-cvs-ssh.xml
  
  Index: howto-cvs-ssh.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
  <howto>
      <header>
          <title>CVS through SSH</title>
          <version>1.0</version>
          <authors>
              <person name="John Morrison" email="morrijr@apache.org"/>
              <person name="Konstantin Piroumian" email="kpiroumian@apache.org"/>  
         
          </authors>
          <abstract>This How-To describes the steps necessary to configure an SSH enabled
CVS connection. It's recommended to configure an SSH enabled CVS connection to work with Apache
code repositories.</abstract>
          <last-modified-content-date date="2002-05-22"/>
      </header>
      <audience title="Intended audience">
          <p>This How-to is aimed at developers who have been granted committer access
to CVS repositories for particular projects.</p>
      </audience>
      <purpose title="Purpose">
          <p> 
                Using SSH to access CVS repositories is recommended for security reasons.
By configuring CVS to work with remote repository using private/public SSH keys you'll be
able to run CVS commands without a need to enter your password every time you need access
to CVS through SSH.
          </p>
          <fixme author="KP">Is this a correct purpose? What else to add?</fixme>
       
      </purpose>
      <prerequisites title="Prerequisites">
          <ul>
              <li>Cygwin - a Unix environment for Windows systems. You can get it <link
href="http://www.redhat.com/sources/">here</link></li>
              <li>Account on the local machine. <em>Better with local administrator
priviledges.</em></li>
              <li>Commiter access to the project(s). <em>This also imply having
account on the CVS host machine.</em></li>
              <li>A CVS GUI application, e.g. WinCVS - this one is not required, but
can be very useful.</li>
          </ul>
          <note>If you are behind a firewall check that you can communicate through
22 or 2401 ports.</note>
          <fixme author="KP">Is it required to have both ports enabled?</fixme>
      </prerequisites>
      <steps title="Steps">
          <p>How to proceed.</p>
          <section title="Terms">
              <dl>
  		    <dt>SSH</dt>
  		    <dd>Secure Shell. See <link href="http://www.openssh.org">OpenSSH</link></dd>
  		    <dt>CVS</dt>
  		    <dd>Concurrent Version System See <link href="http://www.cvshome.org" >CVS
Home Page</link></dd>
  	       </dl>						
          </section>
          <section title="Setting up domain users">
              <note><strong>$</strong> represents local, <strong>%</strong>
remote machine.</note>
              <p>If you are a domain user then you should be added to Cygwin users list
(See <code>[cygwin-dir]/etc/passwd</code>). 
              </p>
              <ul>
              	<li>Start Cygwin, enter following commands:</li>
              </ul>
              <source>
  $ whoami
  administrator
  $ mkgroup -d > /etc/group
  $ mkpasswd -d | grep 'userxxx' >> /etc/passwd
  $ exit
  		</source>
   	     <note>Replace 'userxxx' by your account name</note>		
  		<ul>
  			<li>Start Cygwin again and check that everything's Ok:</li>
  		</ul>
  		<source>
  $ whoami
  userxxx
              </source>
          </section>
          <section title="Setting up SSH access">
              <p>Start Cygwin, then enter:</p>
              <source>
  $ ssh-user-config
  	Shall I create an SSH1 RSA identity file for you? (yes/no) no
  	Shall I create an SSH2 RSA identity file for you? (yes/no)  (yes/no) no
  	Shall I create an SSH2 DSA identity file for you? (yes/no)  (yes/no) yes
  	Generating /home/userxxx/.ssh/id_dsa
  	Enter passphrase (empty for no passphrase):
  	Enter same passphrase again:
  	Do you want to use this identity to login to this machine? (yes/no) yes
  	Adding to /home/userxxx/.ssh/authorized_keys2
  	
  	Configuration finished. Have fun!
  		</source>
  		<p>
  			Now you have configured SSH on your machine. Next you have to setup access to the CVS
machine.
  		</p>
          </section>
          <section title="Setting up passphrase access">
              <p>Perform the following:</p>
              <source>
  $ scp ~/.ssh/id_dsa.pub userxxx@cvs.apache.org:.
  $ ssh -l userxxx -L 2401:localhost:2401 cvs.apache.org
  % cat ~/id_dsa.pub >> ~/.ssh/authorized_keys2
  % rm ~/id_dsa.pub
  % chmod 600 ~/.ssh/*
  % exit            
              </source>
              <note>Note, that the account name on CVS machine can differ from your
local account name.</note>
              <p>
              Check that your configuration is correct:
              </p>
              <source>
  $ ssh -l userxxx -L 2401:localhost:2401 cvs.apache.org
              </source>
              <p>
              or simply
              </p>
              <source>
  $ ssh userxxx@cvs.apache.org
              </source>
              <p>
              If now you are logged in to the to the CVS machine without entering the password
then everything's Ok.
              </p>           
          </section>
          <section title="Getting the project from CVS">
          	  <p>Now you are ready to get a project from CVS using SSH connection. You
can do it either using Cygwin console, Windows command line (you should add cvs.exe directory
to your system PATH) or a GUI like WinCVS.</p>
          	  <p>E.g. how it is done using Cygwin</p>
              <source>
  $ export CVS_RSH=/bin/ssh
  $ cvs -d :ext:userxxx@cvs.apache.org:/home/cvs co xml-cocoon2            
              </source>
          </section>
          <section title="How to setup WinCVS">
              <ul>
                  <li>Add ssh.exe directory to your system PATH environment variable.
Say: <br/>
                  <code>C:\>set PATH=%PATH%;C:\cygwin\bin</code></li>
                  <li>Add <code>CVS_RSH=ssh</code> environment variable</li>
              </ul>
              <p>
              Start WinCVS, then:
              </p>
              <ul>
                  <li>From the main menu select <strong>Admin</strong></li>
                  <li>Then select <strong>Preferences</strong></li>
                  <li>In the dialog that comes up: <br/>
                  Set the CVSROOT to <code>userxxx@cvs.apache.org:/home/cvs</code></li>
                  <li>Set the Authentication to SSH Server</li>              
 
                  <li>Click Ok</li>
              </ul>
          </section>
          <section title="References">
              <p>
                  You can find more on CVS, SSH and WinCVS here:
              </p>
              <ul>
                  <li><link href="http://www.cvshome.org">CVS Home Page</link></li>
           
                  <li><link href="http://www.openssh.org">OpenSSH</link></li>
           
                  <li><link href="http://www.redhat.com/sources">Cygwin Download
Page</link></li>            
                  <li><link href="http://odin.himinbi.org/wincvs-over-ssh/">WinCVS
over SSH</link></li>
              </ul>
          </section>
      </steps>
  </howto>
  
  
  

Mime
View raw message