Documentation/git-cvsserver.txt

   1 git-cvsserver(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-cvsserver - A CVS server emulator for git
   7
   8 SYNOPSIS
   9 --------
  10
  11 SSH:
  12
  13 [verse]
  14 export CVS_SERVER="git cvsserver"
  15 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name>
  16
  17 pserver (/etc/inetd.conf):
  18
  19 [verse]
  20 cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
  21
  22 Usage:
  23
  24 [verse]
  25 'git-cvsserver' [options] [pserver|server] [<directory> ...]
  26
  27 OPTIONS
  28 -------
  29
  30 All these options obviously only make sense if enforced by the server side.
  31 They have been implemented to resemble the linkgit:git-daemon[1] options as
  32 closely as possible.
  33
  34 --base-path <path>::
  35 Prepend 'path' to requested CVSROOT
  36
  37 --strict-paths::
  38 Don't allow recursing into subdirectories
  39
  40 --export-all::
  41 Don't check for `gitcvs.enabled` in config. You also have to specify a list
  42 of allowed directories (see below) if you want to use this option.
  43
  44 -V::
  45 --version::
  46 Print version information and exit
  47
  48 -h::
  49 -H::
  50 --help::
  51 Print usage information and exit
  52
  53 <directory>::
  54 You can specify a list of allowed directories. If no directories
  55 are given, all are allowed. This is an additional restriction, gitcvs
  56 access still needs to be enabled by the `gitcvs.enabled` config option
  57 unless '--export-all' was given, too.
  58
  59
  60 DESCRIPTION
  61 -----------
  62
  63 This application is a CVS emulation layer for git.
  64
  65 It is highly functional. However, not all methods are implemented,
  66 and for those methods that are implemented,
  67 not all switches are implemented.
  68
  69 Testing has been done using both the CLI CVS client, and the Eclipse CVS
  70 plugin. Most functionality works fine with both of these clients.
  71
  72 LIMITATIONS
  73 -----------
  74
  75 Currently cvsserver works over SSH connections for read/write clients, and
  76 over pserver for anonymous CVS access.
  77
  78 CVS clients cannot tag, branch or perform GIT merges.
  79
  80 'git-cvsserver' maps GIT branches to CVS modules. This is very different
  81 from what most CVS users would expect since in CVS modules usually represent
  82 one or more directories.
  83
  84 INSTALLATION
  85 ------------
  86
  87 1. If you are going to offer anonymous CVS access via pserver, add a line in
  88    /etc/inetd.conf like
  89 +
  90 --
  91 ------
  92    cvspserver stream tcp nowait nobody git-cvsserver pserver
  93
  94 ------
  95 Note: Some inetd servers let you specify the name of the executable
  96 independently of the value of argv[0] (i.e. the name the program assumes
  97 it was executed with). In this case the correct line in /etc/inetd.conf
  98 looks like
  99
 100 ------
 101    cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
 102
 103 ------
 104 No special setup is needed for SSH access, other than having GIT tools
 105 in the PATH. If you have clients that do not accept the CVS_SERVER
 106 environment variable, you can rename 'git-cvsserver' to `cvs`.
 107
 108 Note: Newer CVS versions (>= 1.12.11) also support specifying
 109 CVS_SERVER directly in CVSROOT like
 110
 111 ------
 112 cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name>
 113 ------
 114 This has the advantage that it will be saved in your 'CVS/Root' files and
 115 you don't need to worry about always setting the correct environment
 116 variable.  SSH users restricted to 'git-shell' don't need to override the default
 117 with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean
 118 'git-cvsserver' and pretends that the other end runs the real 'cvs' better.
 119 --
 120 2. For each repo that you want accessible from CVS you need to edit config in
 121    the repo and add the following section.
 122 +
 123 --
 124 ------
 125    [gitcvs]
 126         enabled=1
 127         # optional for debugging
 128         logfile=/path/to/logfile
 129
 130 ------
 131 Note: you need to ensure each user that is going to invoke 'git-cvsserver' has
 132 write access to the log file and to the database (see
 133 <<dbbackend,Database Backend>>. If you want to offer write access over
 134 SSH, the users of course also need write access to the git repository itself.
 135
 136 You also need to ensure that each repository is "bare" (without a git index
 137 file) for `cvs commit` to work. See linkgit:gitcvs-migration[7].
 138
 139 [[configaccessmethod]]
 140 All configuration variables can also be overridden for a specific method of
 141 access. Valid method names are "ext" (for SSH access) and "pserver". The
 142 following example configuration would disable pserver access while still
 143 allowing access over SSH.
 144 ------
 145    [gitcvs]
 146         enabled=0
 147
 148    [gitcvs "ext"]
 149         enabled=1
 150 ------
 151 --
 152 3. If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command,
 153    automatically saving it in your 'CVS/Root' files, then you need to set them
 154    explicitly in your environment.  CVSROOT should be set as per normal, but the
 155    directory should point at the appropriate git repo.  As above, for SSH clients
 156    _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'.
 157 +
 158 --
 159 ------
 160      export CVSROOT=:ext:user@server:/var/git/project.git
 161      export CVS_SERVER="git cvsserver"
 162 ------
 163 --
 164 4. For SSH clients that will make commits, make sure their server-side
 165    .ssh/environment files (or .bashrc, etc., according to their specific shell)
 166    export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,
 167    GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL.  For SSH clients whose login
 168    shell is bash, .bashrc may be a reasonable alternative.
 169
 170 5. Clients should now be able to check out the project. Use the CVS 'module'
 171    name to indicate what GIT 'head' you want to check out.  This also sets the
 172    name of your newly checked-out directory, unless you tell it otherwise with
 173    `-d <dir_name>`.  For example, this checks out 'master' branch to the
 174    `project-master` directory:
 175 +
 176 ------
 177      cvs co -d project-master master
 178 ------
 179
 180 [[dbbackend]]
 181 Database Backend
 182 ----------------
 183
 184 'git-cvsserver' uses one database per git head (i.e. CVS module) to
 185 store information about the repository to maintain consistent
 186 CVS revision numbers. The database needs to be
 187 updated (i.e. written to) after every commit.
 188
 189 If the commit is done directly by using `git` (as opposed to
 190 using 'git-cvsserver') the update will need to happen on the
 191 next repository access by 'git-cvsserver', independent of
 192 access method and requested operation.
 193
 194 That means that even if you offer only read access (e.g. by using
 195 the pserver method), 'git-cvsserver' should have write access to
 196 the database to work reliably (otherwise you need to make sure
 197 that the database is up-to-date any time 'git-cvsserver' is executed).
 198
 199 By default it uses SQLite databases in the git directory, named
 200 `gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates
 201 temporary files in the same directory as the database file on
 202 write so it might not be enough to grant the users using
 203 'git-cvsserver' write access to the database file without granting
 204 them write access to the directory, too.
 205
 206 The database can not be reliably regenerated in a
 207 consistent form after the branch it is tracking has changed.
 208 Example: For merged branches, 'git-cvsserver' only tracks
 209 one branch of development, and after a 'git merge' an
 210 incrementally updated database may track a different branch
 211 than a database regenerated from scratch, causing inconsistent
 212 CVS revision numbers. `git-cvsserver` has no way of knowing which
 213 branch it would have picked if it had been run incrementally
 214 pre-merge. So if you have to fully or partially (from old
 215 backup) regenerate the database, you should be suspicious
 216 of pre-existing CVS sandboxes.
 217
 218 You can configure the database backend with the following
 219 configuration variables:
 220
 221 Configuring database backend
 222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 223
 224 'git-cvsserver' uses the Perl DBI module. Please also read
 225 its documentation if changing these variables, especially
 226 about `DBI->connect()`.
 227
 228 gitcvs.dbname::
 229         Database name. The exact meaning depends on the
 230         selected database driver, for SQLite this is a filename.
 231         Supports variable substitution (see below). May
 232         not contain semicolons (`;`).
 233         Default: '%Ggitcvs.%m.sqlite'
 234
 235 gitcvs.dbdriver::
 236         Used DBI driver. You can specify any available driver
 237         for this here, but it might not work. cvsserver is tested
 238         with 'DBD::SQLite', reported to work with
 239         'DBD::Pg', and reported *not* to work with 'DBD::mysql'.
 240         Please regard this as an experimental feature. May not
 241         contain colons (`:`).
 242         Default: 'SQLite'
 243
 244 gitcvs.dbuser::
 245         Database user. Only useful if setting `dbdriver`, since
 246         SQLite has no concept of database users. Supports variable
 247         substitution (see below).
 248
 249 gitcvs.dbpass::
 250         Database password.  Only useful if setting `dbdriver`, since
 251         SQLite has no concept of database passwords.
 252
 253 gitcvs.dbTableNamePrefix::
 254         Database table name prefix.  Supports variable substitution
 255         (see below).  Any non-alphabetic characters will be replaced
 256         with underscores.
 257
 258 All variables can also be set per access method, see <<configaccessmethod,above>>.
 259
 260 Variable substitution
 261 ^^^^^^^^^^^^^^^^^^^^^
 262 In `dbdriver` and `dbuser` you can use the following variables:
 263
 264 %G::
 265         git directory name
 266 %g::
 267         git directory name, where all characters except for
 268         alpha-numeric ones, `.`, and `-` are replaced with
 269         `_` (this should make it easier to use the directory
 270         name in a filename if wanted)
 271 %m::
 272         CVS module/git head name
 273 %a::
 274         access method (one of "ext" or "pserver")
 275 %u::
 276         Name of the user running 'git-cvsserver'.
 277         If no name can be determined, the
 278         numeric uid is used.
 279
 280 ENVIRONMENT
 281 -----------
 282
 283 These variables obviate the need for command-line options in some
 284 circumstances, allowing easier restricted usage through git-shell.
 285
 286 GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path.
 287
 288 GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The
 289 repository must still be configured to allow access through
 290 git-cvsserver, as described above.
 291
 292 When these environment variables are set, the corresponding
 293 command-line arguments may not be used.
 294
 295 Eclipse CVS Client Notes
 296 ------------------------
 297
 298 To get a checkout with the Eclipse CVS client:
 299
 300 1. Select "Create a new project -> From CVS checkout"
 301 2. Create a new location. See the notes below for details on how to choose the
 302    right protocol.
 303 3. Browse the 'modules' available. It will give you a list of the heads in
 304    the repository. You will not be able to browse the tree from there. Only
 305    the heads.
 306 4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the
 307    "launch commit wizard" to avoid committing the .project file.
 308
 309 Protocol notes: If you are using anonymous access via pserver, just select that.
 310 Those using SSH access should choose the 'ext' protocol, and configure 'ext'
 311 access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
 312 "`git cvsserver`". Note that password support is not good when using 'ext',
 313 you will definitely want to have SSH keys setup.
 314
 315 Alternatively, you can just use the non-standard extssh protocol that Eclipse
 316 offer. In that case CVS_SERVER is ignored, and you will have to replace
 317 the cvs utility on the server with 'git-cvsserver' or manipulate your `.bashrc`
 318 so that calling 'cvs' effectively calls 'git-cvsserver'.
 319
 320 Clients known to work
 321 ---------------------
 322
 323 - CVS 1.12.9 on Debian
 324 - CVS 1.11.17 on MacOSX (from Fink package)
 325 - Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
 326 - TortoiseCVS
 327
 328 Operations supported
 329 --------------------
 330
 331 All the operations required for normal use are supported, including
 332 checkout, diff, status, update, log, add, remove, commit.
 333 Legacy monitoring operations are not supported (edit, watch and related).
 334 Exports and tagging (tags and branches) are not supported at this stage.
 335
 336 CRLF Line Ending Conversions
 337 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 338
 339 By default the server leaves the '-k' mode blank for all files,
 340 which causes the cvs client to treat them as a text files, subject
 341 to crlf conversion on some platforms.
 342
 343 You can make the server use `crlf` attributes to set the '-k' modes
 344 for files by setting the `gitcvs.usecrlfattr` config variable.
 345 In this case, if `crlf` is explicitly unset ('-crlf'), then the
 346 server will set '-kb' mode for binary files. If `crlf` is set,
 347 then the '-k' mode will explicitly be left blank.  See
 348 also linkgit:gitattributes[5] for more information about the `crlf`
 349 attribute.
 350
 351 Alternatively, if `gitcvs.usecrlfattr` config is not enabled
 352 or if the `crlf` attribute is unspecified for a filename, then
 353 the server uses the `gitcvs.allbinary` config for the default setting.
 354 If `gitcvs.allbinary` is set, then file not otherwise
 355 specified will default to '-kb' mode. Otherwise the '-k' mode
 356 is left blank. But if `gitcvs.allbinary` is set to "guess", then
 357 the correct '-k' mode will be guessed based on the contents of
 358 the file.
 359
 360 For best consistency with 'cvs', it is probably best to override the
 361 defaults by setting `gitcvs.usecrlfattr` to true,
 362 and `gitcvs.allbinary` to "guess".
 363
 364 Dependencies
 365 ------------
 366 'git-cvsserver' depends on DBD::SQLite.
 367
 368 Copyright and Authors
 369 ---------------------
 370
 371 This program is copyright The Open University UK - 2006.
 372
 373 Authors:
 374
 375 - Martyn Smith    <martyn@catalyst.net.nz>
 376 - Martin Langhoff <martin@catalyst.net.nz>
 377
 378 with ideas and patches from participants of the git-list <git@vger.kernel.org>.
 379
 380 Documentation
 381 --------------
 382 Documentation by Martyn Smith <martyn@catalyst.net.nz>, Martin Langhoff <martin@catalyst.net.nz>, and Matthias Urlichs <smurf@smurf.noris.de>.
 383
 384 GIT
 385 ---
 386 Part of the linkgit:git[1] suite