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