|
|
|
|
A Minimal Guide to CVS with SSHAuthor: Amund Tveit, ae@amundtveit.infoThis is a guide to using CVS (Concurrent Versions System) with SSH (Secure Shell) to enable efficient and secure version control for open source (or closed source) software development projects. Source doesn't necessarily mean program code, but can also be documents (e.g. .doc, .xml, .fm, .pdf, .ps) or other binary/textual files (.xls, .vsd). My usual server configuration is either using the SourceForge repository for open source projects, or a Unix box at my work or the University for commercial and private projects. For CVS/SSH client access I mostly use Windows with Cygwin. (note: 2001, at grad.school)
PrerequisitesThis assumes that the CVS repository should be residing on the server, and the development on the client.Server(s)
Client(s)
User Account
Commands that should be done on the server is are marked with
Assume that the server is Initialize CVS RepositoryOn the server you need to do some preparations before the CVS repository can be used:serbox$ mkdir -p /usr/local/cvsrepository serbox$ export CVSROOT="/usr/local/cvsrepository" serbox$ cvs initThen the repository should be avaible to use, but you need to set some environment variables at the client ( $CVSROOT refers to the CVS repository, and $CVS_RSH refers to the communication protocol and medium)
devbox$ export CVSROOT=":ext:developer@serbox.domain.com:/usr/local/cvsrepository" devbox$ export CVS_RSH="ssh" Creating a CVS ProjectAssuming that you have some files in a directory calledYourProject that you would like to add to a project with the same name.
devbox$ cd YourProject devbox$ cvs import -m "initial import of YourProject" YourProject myself start( myself is the vendor tag, and start is the release tag)
Checking In/Out Files/ProjectsTo check out code from the repository do:devbox$ cvs checkout YourProjectTo check in modifications (on existing files) devbox$ cvs commit
cvs update before commiting changes
Adding/Removing FilesTo add a new file to the repository do:devbox$ cvs add newFile devbox$ cvs commitTo add a new binary file to the repository do: devbox$ cvs add -kb newBinaryFile devbox$ cvs commit( -kb specifies that file is binary)
To add a new directory to the repository do: devbox$ cvs add newDirectory devbox$ cvs commit To remove an existing file from the repository do: devbox$ rm existingFile devbox$ cvs remove existingFile devbox$ cvs commit Staying in sync with other developersIn order to receive changes from the latest commits from your peer developers, do:devbox$ cvs updateIf another developer has done bigger changes such as adding new directories etc. do: devbox$ cvs update -d Creating ReleasesSince there usually are several files with different version numbers in a project, it's a good idea to "stamp" the files with a release tag for each release, this can be done like this (for version "v001"):devbox$ cvs tag -R "v001" devbox$ cvs commitThis release can be checked out with devbox$ cvs checkout -r "v001" YourProject Lazy, but convenient ssh authenticationIf you're tired of entering passwords for each simple CVS command, please continue reading: You can distribute your ssh-identity from the client to the server in order to allow automatic identification (i.e. no password needed!), this can be done byssh 1: devbox$ cd $HOME devbox$ ssh-keygen ssh 2: p devbox$ cd $HOME devbox$ ssh-keygen -t rsaYou should be asked to save 'your identification' in /home/developer/.ssh/identity (ssh 1) or /home/developer/.ssh/id_rsa.pub (ssh 2) (or wherever $HOME points to), just hit enter. When asked for password and confirmation of password, continue hitting enter. Then copy your public key ( identity.pub for ssh 1 or id_rsa.pub for ssh 2) to the server using secure copy (a part of ssh):
ssh 1: devbox$ scp .ssh/identity.pub developer@serbox.domain.com:~/.ssh ssh 2: devbox$ scp .ssh/id_rsa.pub developer@serbox.domain.com:~/.sshThen log onto the server and fix the authorized_keys file.
ssh 1: devbox$ ssh developer@serbox.domain.com serbox$ cd .ssh serbox$ cat identity.pub >> authorized_keys ssh 2: devbox$ ssh developer@serbox.domain.com serbox$ cd .ssh serbox$ cat id_rsa.pub >> authorized_keys2 serbox$ chmod go-w authorized_keys2You should now be able to ssh directly from the client to server without having to enter password, this can be tested with: ssh 1 or ssh 2: devbox$ ssh developer@serbox.domain.comVersion control from this point should not require you to enter the password. Note: This enables anyone getting access to your client to continue into the server without knowing the password on the server. Encrypted DisksIf you fear the situation of someone taking over your computer, the risk can be (somewhat) reduced by using a encrypted disk, e.g. PGPDisk holding the $HOME directory on the client. So when an intruder takes over your machine s/he needs to know the password for your encrypted disk in order to get further into the server. Another advantage of using a encrypted disk is that your (checked out) source code can reside on it.
Academic/Educational Use of this Guide
Other sources that refers to this guide
AcknowledgmentsThanks to Eric Montagne and Derek Keeler for ssh 2 instructions.Other CVS and SSH ResourcesFeedbackYour feedback is greatly appreciated, please take your time filling out the form below so I can continue to improve this minimal guide.
Written by Amund Tveit, 2001-09-25, last updated 2001-09-25.
|
|