git-cvsserver(1)
git-cvsserver(1) Manual Page NAME git-cvsserver - A CVS server emulator for Git SYNOPSIS SSH: export CVS_SERVER="git cvsserver" cvs -d :ext:user@server/path/repo.git co <HEAD_name> pserver (/etc/inetd.conf): cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver Usage: git-cvsserver [<options>] [pserver|server] [<directory> …] DESCRIPTION This application is a CVS emulation layer for Git.
It is highly functional. However, not all methods are implemented, and for those methods that are implemented, not all switches are implemented. Testing has been done using both the CLI CVS client, and the Eclipse CVS plugin. Most functionality works fine with both of these clients. OPTIONS All these options obviously only make sense if enforced by the server side. They have been implemented to resemble the git-daemon(1) options as closely as possible. --base-path <path> Prepend path to requested CVSROOT --strict-paths Don’t allow recursing into subdirectories --export-all Don’t check for gitcvs.enabled in config.
You also have to specify a list of allowed directories (see below) if you want to use this option. -V --version Print version information and exit -h -H --help Print usage information and exit <directory> The remaining arguments provide a list of directories. If no directories are given, then all are allowed. Repositories within these directories still require the gitcvs.enabled config option, unless --export-all is specified.
LIMITATIONS CVS clients cannot tag, branch or perform Git merges. git-cvsserver maps Git branches to CVS modules. This is very different from what most CVS users would expect since in CVS modules usually represent one or more directories. INSTALLATION If you are going to offer CVS access via pserver, add a line in /etc/inetd.conf like cvspserver stream tcp nowait nobody git-cvsserver pserver Note: Some inetd servers let you specify the name of the executable independently of the value of argv[0] (i.e. the name the program assumes it was executed with).
In this case the correct line in /etc/inetd.conf looks like cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver Only anonymous access is provided by pserver by default. To commit you will have to create pserver accounts, simply add a gitcvs.authdb setting in the config file of the repositories you want the cvsserver to allow writes to, for example: [gitcvs] authdb = /etc/cvsserver/passwd The format of these files is username followed by the encrypted password, for example: myuser:sqkNi8zPf01HI myuser:$1$9K7FzU28$VfF6EoPYCJEYcVQwATgOP/ myuser:$5$.NqmNH1vwfzGpV8B$znZIcumu1tNLATgV2l6e1/mY8RzhUDHMOaVOeL1cxV3 You can use the htpasswd facility that comes with Apache to make these files, but only with the -d option (or -B if your system supports it).
Preferably use the system specific utility that manages password hash creation in your platform (e.g. mkpasswd in Linux, encrypt in OpenBSD or pwhash in NetBSD) and paste it in the right location. Then provide your password via the pserver method, for example: cvs -d:pserver:someuser:somepassword@server:/path/repo.git co <HEAD_name> No special setup is needed for SSH access, other than having Git tools in the PATH. If you have clients that do not accept the CVS_SERVER environment variable, you can rename git-cvsserver to cvs .
Note: Newer CVS versions (>= 1.12.11) also support specifying CVS_SERVER directly in CVSROOT like cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name> This has the advantage that it will be saved in your CVS/Root files and you don’t need to worry about always setting the correct environment variable. SSH users restricted to git-shell don’t need to override the default with CVS_SERVER (and shouldn’t) as git-shell understands cvs to mean git-cvsserver and pretends that the other end runs the real cvs better.
For each repo that you want accessible from CVS you need to edit config in the repo and add the following section. [gitcvs] enabled=1 # optional for debugging logFile=/path/to/logfile Note: you need to ensure each user that is going to invoke git-cvsserver has write access to the log file and to the database (see Database Backend . If you want to offer write access over SSH, the users of course also need write access to the Git repository itself.
You also need to ensure that each repository is "bare" (without a Git index file) for cvs commit to work. See gitcvs-migration(7) . All configuration variables can also be overridden for a specific method of access. Valid method names are "ext" (for SSH access) and "pserver". The following example configuration would disable pserver access while still allowing access over SSH. [gitcvs] enabled=0 [gitcvs "ext"] enabled=1 If you didn’t specify the CVSROOT/CVS_SERVER directly in the checkout command, automatically saving it in your CVS/Root files, then you need to set them explicitly in your environment.
CVSROOT should be set as per normal, but the directory should point at the appropriate Git repo. As above, for SSH clients not restricted to git-shell , CVS_SERVER should be set to git-cvsserver . export CVSROOT=:ext:user@server:/var/git/project.git export CVS_SERVER="git cvsserver" For SSH clients that will make commits, make sure their server-side .ssh/environment files (or .bashrc, etc., according to their specific shell) export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL.
For SSH clients whose login shell is bash, .bashrc may be a reasonable alternative. Clients should now be able to check out the project. Use the CVS module name to indicate what Git head you want to check out. This also sets the name of your newly checked-out directory, unless you tell it otherwise with -d <dir-name> . For example, this checks out master branch to the project-master directory: cvs co -d project-master master DATABASE BACKEND git-cvsserver uses one database per Git head (i.e.
CVS module) to store information about the repository to maintain consistent CVS revision numbers. The database needs to be updated (i.e. written to) after every commit. If the commit is done directly by using git (as opposed to using git-cvsserver ) the update will need to happen on the next repository access by git-cvsserver , independent of access method and requested operation. That means that even if you offer only read access (e.g. by using the pserver method), git-cvsserver should have write access to the database to work reliably (otherwise you need to make sure that the database is up to date any time git-cvsserver is executed).
By default it uses SQLite databases in the Git directory, named gitcvs. <module-name> .sqlite . Note that the SQLite backend creates temporary files in the same directory as the database file on write so it might not be enough to grant the users using git-cvsserver write access to the database file without granting them write access to the directory, too. The database cannot be reliably regenerated in a consistent form after the branch it is tracking has changed.
Example: For merged branches, git-cvsserver only tracks one branch of development, and after a git merge an incrementally updated database may track a different branch than a database regenerated from scratch, causing inconsistent CVS revision numbers. git-cvsserver has no way of knowing which branch it would have picked if it had been run incrementally pre-merge. So if you have to fully or partially (from old backup) regenerate the database, you should be suspicious of pre-existing CVS sandboxes.
You can configure the database backend with the following configuration variables: Configuring database backend git-cvsserver uses the Perl DBI module. Please also read its documentation if changing these variables, especially about DBI- > connect (). gitcvs.dbName Database name. The exact meaning depends on the selected database driver, for SQLite this is a filename. Supports varia
The rest of this page is on the live site.